def test_azure_devops_user_add_command(requests_mock):
"""
Scenario: Add user to organization.
Given:
- User has provided valid credentials.
When:
- azure-devops-user-add called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Validate API operation result error handling.
"""
from AzureDevOps import Client, user_add_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
user_email = '*****@*****.**'
account_license_type = 'express'
group_type = 'projectReader'
project_id = '123'
url = f"https://vsaex.dev.azure.com/{ORGANIZATION}/_apis/UserEntitlements"
mock_response = json.loads(load_mock_response('add_user.json'))
requests_mock.post(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = user_add_command(
client, {
'user_email': user_email,
'account_license_type': account_license_type,
'group_type': group_type,
'project_id': project_id
})
assert len(result.outputs) == 8
assert result.outputs_prefix == 'AzureDevOps.User'
assert result.outputs.get('id') == 'XXX'
assert dict_safe_get(result.outputs,
['accessLevel', 'accountLicenseType']) == 'express'
assert result.outputs.get('lastAccessedDate') == '0001-01-01T00:00:00Z'
# Error case
mock_response = json.loads(load_mock_response('add_user_error.json'))
requests_mock.post(url, json=mock_response)
with pytest.raises(Exception):
user_add_command(
client, {
'user_email': user_email,
'account_license_type': account_license_type,
'group_type': group_type,
'project_id': project_id
})
def test_is_new_pr(requests_mock):
"""
Validate if there is new pull-request in the repository.
Given:
- User has provided valid credentials.
When:
- fetch-incidents called.
Then:
- Ensure the return value is correct.
"""
from AzureDevOps import Client, is_new_pr
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'test'
repository = 'xsoar'
url = f'{BASE_URL}/{project}/_apis/git/repositories/{repository}/pullrequests/'
mock_response = json.loads(load_mock_response('list_pull_request.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
assert is_new_pr(project, repository, client, 23)
assert is_new_pr(project, repository, client, 22)
assert not is_new_pr(project, repository, client, 24)
assert not is_new_pr(project, repository, client, 25)
def test_azure_devops_user_remove_command(requests_mock):
"""
Scenario: Remove the user from all project memberships.
Given:
- User has provided valid credentials.
When:
- azure-devops-user-remove called.
Then:
- Ensure that the output is empty (None).
- Ensure readable output message content.
"""
from AzureDevOps import Client, user_remove_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
user_id = '1'
url = f'https://vsaex.dev.azure.com/{ORGANIZATION}/_apis/userentitlements/{user_id}'
requests_mock.delete(url)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = user_remove_command(client, {'user_id': user_id})
assert result.outputs is None
assert result.outputs_prefix is None
assert result.readable_output == f'User {user_id} was successfully removed from the organization.'
def test_azure_devops_pull_request_update_command(requests_mock):
"""
Scenario: Update a pull request.
Given:
- User has provided valid credentials.
When:
- azure-devops-pull-request-update called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Ensure command validates that is at least one update parameter exists.
"""
from AzureDevOps import Client, pull_request_update_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'test'
repository_id = '1'
pull_request_id = '2'
url = f'{BASE_URL}/{project}/_apis/git/repositories/{repository_id}/pullrequests/{pull_request_id}'
mock_response = json.loads(load_mock_response('pull_request.json'))
requests_mock.patch(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = pull_request_update_command(
client, {
'project': project,
'repository_id': repository_id,
'pull_request_id': pull_request_id,
'title': 'new-title'
})
assert len(result.outputs) == 21
assert result.outputs_prefix == 'AzureDevOps.PullRequest'
assert result.outputs.get('repository').get('name') == 'xsoar'
with pytest.raises(Exception):
pull_request_update_command(
client, {
'project': project,
'repository_id': repository_id,
'pull_request_id': pull_request_id
})
def test_azure_devops_pipeline_run_list_command(requests_mock):
"""
Scenario: Retrieve project pipeline runs list.
Given:
- User has provided valid credentials.
When:
- azure-devops-pipeline-run-list called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Ensure the command validates the 'limit' parameter value. The parameter value should be equals or greater than 1.
"""
from AzureDevOps import Client, pipeline_run_list_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'xsoar'
pipeline_id = '1'
url = f'{BASE_URL}/{project}/_apis/pipelines/{pipeline_id}/runs'
mock_response = json.loads(load_mock_response('pipeline_run_list.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = pipeline_run_list_command(client, {
"project": project,
'pipeline_id': pipeline_id
})
assert len(result.outputs) == 2
assert result.outputs_prefix == 'AzureDevOps.PipelineRun'
assert result.outputs[0].get('project') == project
assert result.outputs[0].get('pipeline').get('name') == 'xsoar'
assert result.outputs[0].get('pipeline').get('id') == "1"
assert result.outputs[0].get('run_id') == "42"
assert result.outputs[0].get('state') == 'completed'
with pytest.raises(Exception):
pipeline_run_list_command(client, {
"project": project,
'pipeline_id': pipeline_id,
'limit': '-1'
})
def test_azure_devops_branch_list_command(requests_mock):
"""
Scenario: Retrieve repository branches list.
Given:
- User has provided valid credentials.
When:
- azure-devops-branch-list called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Ensure the command validates the 'limit' parameter value. The parameter value should be equals or greater than 1.
"""
from AzureDevOps import Client, branch_list_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'xsoar'
repository = 'test'
url = f'{BASE_URL}/{project}/_apis/git/repositories/{repository}/refs'
mock_response = json.loads(load_mock_response('branch_list.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = branch_list_command(client, {
"project": project,
"repository": repository
})
assert len(result.outputs) == 2
assert result.outputs_prefix == 'AzureDevOps.Branch'
assert result.outputs[0].get('repository') == repository
assert result.outputs[0].get('name') == 'refs/heads/main'
with pytest.raises(Exception):
branch_list_command(client, {
"project": project,
"repository": repository,
'limit': '-1'
})
def test_azure_devops_pull_request_create_command(requests_mock):
"""
Scenario: Create a new pull-request..
Given:
- User has provided valid credentials.
When:
- azure-devops-pull-request-create called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
"""
from AzureDevOps import Client, pull_request_create_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'test'
repository_id = '1'
url = f'{BASE_URL}/{project}/_apis/git/repositories/{repository_id}/pullrequests'
mock_response = json.loads(load_mock_response('pull_request.json'))
requests_mock.post(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = pull_request_create_command(
client, {
'project': project,
'repository_id': repository_id,
'source_branch': 'my-branch',
'target_branch': 'main',
'title': 'test-title',
'description': 'test-description',
'reviewers_ids': '2'
})
assert len(result.outputs) == 21
assert result.outputs_prefix == 'AzureDevOps.PullRequest'
assert result.outputs.get('repository').get('name') == 'xsoar'
def test_azure_devops_pipeline_run_get_command(requests_mock):
"""
Scenario: Retrieve pipeline run information.
Given:
- User has provided valid credentials.
When:
- azure-devops-pipeline-run-get called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
"""
from AzureDevOps import Client, pipeline_run_get_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'xsoar'
pipeline_id = '1'
run_id = '2'
url = f'{BASE_URL}/{project}/_apis/pipelines/{pipeline_id}/runs/{run_id}'
mock_response = json.loads(load_mock_response('get_pipeline_run.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = pipeline_run_get_command(client, {
"project": project,
'pipeline_id': pipeline_id,
'run_id': run_id
})
assert len(result.outputs) == 11
assert result.outputs_prefix == 'AzureDevOps.PipelineRun'
assert result.outputs.get('project') == project
assert result.outputs.get('pipeline').get('name') == 'xsoar'
assert result.outputs.get('pipeline').get('id') == "1"
assert result.outputs.get('run_id') == "3"
def test_get_last_fetch_incident_index(requests_mock, test_object):
"""
Scenario: Retrieve the index of the last fetched pull-request.
Given:
- User has provided valid credentials.
- Case A: No new pull-requests - The last pull-request is already fetched and active.
- Case B: One new pull-requests.
- Case C: No new pull-requests - The last pull request is already fetched and no longer active.
- Case D: There is new pull-requests - The last pull request is not yet fetched,
and the last-fetched pull-request is no longer active.
When:
- fetch-incidents called.
Then:
- Ensure the return value is correct.
"""
from AzureDevOps import Client, get_last_fetch_incident_index
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
project = 'test'
repository = 'xsoar'
url = f'{BASE_URL}/{project}/_apis/git/repositories/{repository}/pullrequests/'
mock_response = json.loads(load_mock_response('list_pull_request.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
assert get_last_fetch_incident_index(
project, repository, client,
test_object['id']) == test_object['result']
def test_azure_devops_users_query_command(requests_mock):
"""
Scenario: Query users in the organization.
Given:
- User has provided valid credentials.
When:
- azure-devops-user-query called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Ensure the command validates the 'limit' parameter value. The parameter value should be equals or greater than 1.
"""
from AzureDevOps import Client, users_query_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
query = 'xsoar'
url = f'{BASE_URL}/_apis/IdentityPicker/Identities'
mock_response = json.loads(load_mock_response('query_user.json'))
requests_mock.post(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = users_query_command(client, {"query": query})
assert len(result.outputs) == 1
assert result.outputs_prefix == 'AzureDevOps.User'
assert result.outputs[0].get('signInAddress') == '*****@*****.**'
with pytest.raises(Exception):
users_query_command(client, {"query": query, 'limit': '-1'})
def test_azure_devops_project_list_command(requests_mock):
"""
Scenario: Retrieve all projects in the organization that the authenticated user has access to.
Given:
- User has provided valid credentials.
When:
- azure-devops-project-list called.
Then:
- Ensure number of items is correct.
- Ensure outputs prefix is correct.
- Ensure a sample value from the API matches what is generated in the context.
- Ensure the command validates the 'limit' parameter value. The parameter value should be equals or greater than 1.
"""
from AzureDevOps import Client, project_list_command
authorization_url = 'https://login.microsoftonline.com/organizations/oauth2/v2.0/token'
requests_mock.post(authorization_url, json=get_azure_access_token_mock())
url = f'{BASE_URL}/_apis/projects'
mock_response = json.loads(load_mock_response('list_project.json'))
requests_mock.get(url, json=mock_response)
client = Client(client_id=CLIENT_ID,
organization=ORGANIZATION,
verify=False,
proxy=False)
result = project_list_command(client, {})
assert len(result.outputs) == 1
assert result.outputs_prefix == 'AzureDevOps.Project'
assert result.outputs[0].get('name') == 'xsoar'
assert result.outputs[0].get('visibility') == 'private'
with pytest.raises(Exception):
project_list_command(client, {'limit': '-1'})
