# Robot Framework Azure Sync
## Overview
The **Robot Framework Azure Sync** package provides synchronization capabilities for Azure-related tasks. It includes scripts to retrieve data from Azure Test Cases **(`robotAzureSyncGet.py`)**, to update Azure Test Cases **(`robotAzureSyncPatch.py`)**, and to run Robot Framework tests with specific tags.
## Installation
To install `robotAzureSync`, you can use `pip`. Open a terminal and run:
```bash
pip install robotAzureSync
```
## Using the project source code
Alternatively, you can download the project source code from the repository and use it directly. You will need to have Python installed on your system.
1. Clone the repository:
```bash
git clone https://AMBEV-SA@dev.azure.com/AMBEV-SA/QAChapter/_git/robot-azure-sync
```
2. Navigate to the project directory:
```bash
cd robot-azure-sync
```
3. Use the provided scripts
- syncUtils.py: Contains utility functions for synchronization.
- robotAzureSyncGet.py: Script to get data from Azure Test Cases.
- robotAzureSyncPatch.py: Script to patch data to Azure Test Cases.
- robotAzureSync.py: Main script for synchronization and running Robot Framework tests.
# Usage
## Using the installed package
If you installed the package via pip, you can use the following commands:
```bash
#Run synchronize_get and synchronize_patch
robotAzureSync
#Just run sync_get
robotAzureSync get
#Run sync_patch only
robotAzureSync patch
```
## Using the project source code
If you are using the project source code directly, you can execute the scripts using Python:
```bash
# Run synchronize_get and synchronize_patch
python robotAzureSync.py
# Just run sync_get
python robotAzureSync.py get
# Run sync_patch only
python robotAzureSync.py patch
```
# Configuration
The package requires a configuration file **'sync_config.json'** with Azure-related settings. If the file is not found, it will be created interactively.
Example **'sync_config.json'**:
```JSON
{
"path": "tests",
"credentials": {
"personal_access_token": "your_azure_personal_access_token",
"organization_name": "your_organization_name",
"project_name": "your_project_name"
},
"tag_config": {
"test_case": "TC",
"user_story": "US",
"bug": "Bug",
"title": "Title",
"TestedBy-Reverse": "",
"IterationPath": "",
"AutomationStatus": "",
"ignore_sync": "",
"System.Tags": "",
"Priority": ""
},
"constants": {
"System.AreaPath": "",
"System.TeamProject": "",
"settings_section": "",
"test_cases_section": ""
}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/fabiorisantosquispe/robot-azure-sync",
"name": "robotAzureSync",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "F\u00e1bio Ribeiro dos Santos Quispe",
"author_email": "fabiorisantos1981@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/71/07/48a3acbcf3b2b2b3db473c932c9600144ecf673c077ab77c3406a827d1e5/robotAzureSync-1.0.0.tar.gz",
"platform": null,
"description": "# Robot Framework Azure Sync \r\n\r\n## Overview\r\n\r\nThe **Robot Framework Azure Sync** package provides synchronization capabilities for Azure-related tasks. It includes scripts to retrieve data from Azure Test Cases **(`robotAzureSyncGet.py`)**, to update Azure Test Cases **(`robotAzureSyncPatch.py`)**, and to run Robot Framework tests with specific tags.\r\n\r\n## Installation\r\n\r\nTo install `robotAzureSync`, you can use `pip`. Open a terminal and run:\r\n\r\n```bash\r\npip install robotAzureSync\r\n```\r\n\r\n## Using the project source code\r\n\r\nAlternatively, you can download the project source code from the repository and use it directly. You will need to have Python installed on your system.\r\n\r\n1. Clone the repository:\r\n\r\n```bash\r\ngit clone https://AMBEV-SA@dev.azure.com/AMBEV-SA/QAChapter/_git/robot-azure-sync\r\n```\r\n\r\n2. Navigate to the project directory:\r\n\r\n```bash\r\ncd robot-azure-sync\r\n```\r\n3. Use the provided scripts\r\n\r\n- syncUtils.py: Contains utility functions for synchronization.\r\n- robotAzureSyncGet.py: Script to get data from Azure Test Cases.\r\n- robotAzureSyncPatch.py: Script to patch data to Azure Test Cases.\r\n- robotAzureSync.py: Main script for synchronization and running Robot Framework tests.\r\n\r\n\r\n# Usage\r\n## Using the installed package\r\nIf you installed the package via pip, you can use the following commands:\r\n\r\n```bash\r\n#Run synchronize_get and synchronize_patch\r\nrobotAzureSync\r\n\r\n#Just run sync_get\r\nrobotAzureSync get\r\n\r\n#Run sync_patch only\r\nrobotAzureSync patch\r\n```\r\n\r\n## Using the project source code\r\nIf you are using the project source code directly, you can execute the scripts using Python:\r\n\r\n```bash\r\n# Run synchronize_get and synchronize_patch\r\npython robotAzureSync.py\r\n\r\n# Just run sync_get\r\npython robotAzureSync.py get\r\n\r\n# Run sync_patch only\r\npython robotAzureSync.py patch\r\n```\r\n\r\n# Configuration\r\nThe package requires a configuration file **'sync_config.json'** with Azure-related settings. If the file is not found, it will be created interactively.\r\n\r\nExample **'sync_config.json'**:\r\n```JSON\r\n{\r\n \"path\": \"tests\",\r\n \"credentials\": {\r\n \"personal_access_token\": \"your_azure_personal_access_token\",\r\n \"organization_name\": \"your_organization_name\",\r\n \"project_name\": \"your_project_name\"\r\n },\r\n \"tag_config\": {\r\n \"test_case\": \"TC\",\r\n \"user_story\": \"US\",\r\n \"bug\": \"Bug\",\r\n \"title\": \"Title\",\r\n \"TestedBy-Reverse\": \"\",\r\n \"IterationPath\": \"\",\r\n \"AutomationStatus\": \"\",\r\n \"ignore_sync\": \"\",\r\n \"System.Tags\": \"\",\r\n \"Priority\": \"\"\r\n },\r\n \"constants\": {\r\n \"System.AreaPath\": \"\",\r\n \"System.TeamProject\": \"\",\r\n \"settings_section\": \"\",\r\n \"test_cases_section\": \"\"\r\n }\r\n}\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Synchronization functionalities for Azure-related tasks.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/fabiorisantosquispe/robot-azure-sync"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3deb869546a850e8105039c36e2a4f8042427094a2782e652cfad180b0457d07",
"md5": "f45442af4284a7870af9dd7a9bed249a",
"sha256": "f0b1150976cb2bf21f6bcfef5eb30e02f668ef56633a94379f712747f1a16f85"
},
"downloads": -1,
"filename": "robotAzureSync-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f45442af4284a7870af9dd7a9bed249a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16089,
"upload_time": "2024-03-04T02:55:21",
"upload_time_iso_8601": "2024-03-04T02:55:21.911193Z",
"url": "https://files.pythonhosted.org/packages/3d/eb/869546a850e8105039c36e2a4f8042427094a2782e652cfad180b0457d07/robotAzureSync-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "710748a3acbcf3b2b2b3db473c932c9600144ecf673c077ab77c3406a827d1e5",
"md5": "a36c92001c87fc5599d41d872628cde5",
"sha256": "b50eef9dbe6585edf4a8fdd554b0f02d16c4e263a432f7865934cf032dad0835"
},
"downloads": -1,
"filename": "robotAzureSync-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a36c92001c87fc5599d41d872628cde5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14038,
"upload_time": "2024-03-04T02:55:24",
"upload_time_iso_8601": "2024-03-04T02:55:24.229596Z",
"url": "https://files.pythonhosted.org/packages/71/07/48a3acbcf3b2b2b3db473c932c9600144ecf673c077ab77c3406a827d1e5/robotAzureSync-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 02:55:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fabiorisantosquispe",
"github_project": "robot-azure-sync",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "robotazuresync"
}
JSON
