-
Notifications
You must be signed in to change notification settings - Fork 23.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding DevTest Lab Artifact facts #53195
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
245 changes: 245 additions & 0 deletions
245
lib/ansible/modules/cloud/azure/azure_rm_devtestlabartifact_facts.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,245 @@ | ||
#!/usr/bin/python | ||
# | ||
# Copyright (c) 2019 Zim Kalinowski, (@zikalino) | ||
# | ||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) | ||
|
||
from __future__ import absolute_import, division, print_function | ||
__metaclass__ = type | ||
|
||
|
||
ANSIBLE_METADATA = {'metadata_version': '1.1', | ||
'status': ['preview'], | ||
'supported_by': 'community'} | ||
|
||
|
||
DOCUMENTATION = ''' | ||
--- | ||
module: azure_rm_devtestlabartifact_facts | ||
version_added: "2.8" | ||
short_description: Get Azure DevTest Lab Artifact facts. | ||
description: | ||
- Get facts of Azure DevTest Lab Artifact. | ||
|
||
options: | ||
resource_group: | ||
description: | ||
- The name of the resource group. | ||
required: True | ||
lab_name: | ||
description: | ||
- The name of the lab. | ||
required: True | ||
artifact_source_name: | ||
description: | ||
- The name of the artifact source. | ||
required: True | ||
name: | ||
description: | ||
- The name of the artifact. | ||
|
||
extends_documentation_fragment: | ||
- azure | ||
|
||
author: | ||
- "Zim Kalinowski (@zikalino)" | ||
|
||
''' | ||
|
||
EXAMPLES = ''' | ||
- name: Get instance of DevTest Lab Artifact | ||
azure_rm_devtestlabartifact_facts: | ||
resource_group: myResourceGroup | ||
lab_name: myLab | ||
artifact_source_name: myArtifactSource | ||
name: myArtifact | ||
''' | ||
|
||
RETURN = ''' | ||
artifacts: | ||
description: A list of dictionaries containing facts for DevTest Lab Artifact. | ||
returned: always | ||
type: complex | ||
contains: | ||
id: | ||
description: | ||
- The identifier of the artifact. | ||
returned: always | ||
type: str | ||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar | ||
tifactSources/myArtifactSource/artifacts/myArtifact" | ||
resource_group: | ||
description: | ||
- Name of the resource group. | ||
returned: always | ||
type: str | ||
sample: myResourceGroup | ||
lab_name: | ||
description: | ||
- Name of the lab. | ||
returned: always | ||
type: str | ||
sample: myLab | ||
artifact_source_name: | ||
description: | ||
- The name of the artifact source. | ||
returned: always | ||
type: str | ||
sample: myArtifactSource | ||
name: | ||
description: | ||
- The name of the artifact. | ||
returned: always | ||
type: str | ||
sample: myArtifact | ||
description: | ||
description: | ||
- Description of the artifact. | ||
returned: always | ||
type: str | ||
sample: Installs My Software | ||
file_path: | ||
description: | ||
- "Artifact's path in the repo." | ||
returned: always | ||
type: str | ||
sample: Artifacts/myArtifact | ||
publisher: | ||
description: | ||
- Publisher name. | ||
returned: always | ||
type: str | ||
sample: MyPublisher | ||
target_os_type: | ||
description: | ||
- Target OS type. | ||
returned: always | ||
type: str | ||
sample: Linux | ||
title: | ||
description: | ||
- Title of the artifact. | ||
returned: always | ||
type: str | ||
sample: My Software | ||
parameters: | ||
description: | ||
- A dictionary containing parameters definition of the artifact. | ||
returned: always | ||
type: complex | ||
sample: {} | ||
''' | ||
|
||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase | ||
|
||
try: | ||
from msrestazure.azure_exceptions import CloudError | ||
from azure.mgmt.devtestlabs import DevTestLabsClient | ||
from msrest.serialization import Model | ||
except ImportError: | ||
# This is handled in azure_rm_common | ||
pass | ||
|
||
|
||
class AzureRMArtifactFacts(AzureRMModuleBase): | ||
def __init__(self): | ||
# define user inputs into argument | ||
self.module_arg_spec = dict( | ||
resource_group=dict( | ||
type='str', | ||
required=True | ||
), | ||
lab_name=dict( | ||
type='str', | ||
required=True | ||
), | ||
artifact_source_name=dict( | ||
type='str', | ||
required=True | ||
), | ||
name=dict( | ||
type='str' | ||
) | ||
) | ||
# store the results of the module operation | ||
self.results = dict( | ||
changed=False | ||
) | ||
self.mgmt_client = None | ||
self.resource_group = None | ||
self.lab_name = None | ||
self.artifact_source_name = None | ||
self.name = None | ||
super(AzureRMArtifactFacts, self).__init__(self.module_arg_spec, supports_tags=False) | ||
|
||
def exec_module(self, **kwargs): | ||
for key in self.module_arg_spec: | ||
setattr(self, key, kwargs[key]) | ||
self.mgmt_client = self.get_mgmt_svc_client(DevTestLabsClient, | ||
base_url=self._cloud_environment.endpoints.resource_manager) | ||
|
||
if self.name: | ||
self.results['artifacts'] = self.get() | ||
else: | ||
self.results['artifacts'] = self.list() | ||
|
||
return self.results | ||
|
||
def get(self): | ||
response = None | ||
results = [] | ||
try: | ||
response = self.mgmt_client.artifacts.get(resource_group_name=self.resource_group, | ||
lab_name=self.lab_name, | ||
artifact_source_name=self.artifact_source_name, | ||
name=self.name) | ||
self.log("Response : {0}".format(response)) | ||
except CloudError as e: | ||
self.log('Could not get facts for Artifact.') | ||
|
||
if response: | ||
results.append(self.format_response(response)) | ||
|
||
return results | ||
|
||
def list(self): | ||
response = None | ||
results = [] | ||
try: | ||
response = self.mgmt_client.artifacts.list(resource_group_name=self.resource_group, | ||
lab_name=self.lab_name, | ||
artifact_source_name=self.artifact_source_name) | ||
self.log("Response : {0}".format(response)) | ||
except CloudError as e: | ||
self.log('Could not get facts for Artifact.') | ||
|
||
if response is not None: | ||
for item in response: | ||
results.append(self.format_response(item)) | ||
|
||
return results | ||
|
||
def format_response(self, item): | ||
d = item.as_dict() | ||
d = { | ||
'resource_group': self.parse_resource_to_dict(d.get('id')).get('resource_group'), | ||
'lab_name': self.parse_resource_to_dict(d.get('id')).get('name'), | ||
'artifact_source_name': self.parse_resource_to_dict(d.get('id')).get('child_name_1'), | ||
'id': d.get('id'), | ||
'description': d.get('description'), | ||
'file_path': d.get('file_path'), | ||
'name': d.get('name'), | ||
'parameters': d.get('parameters'), | ||
'publisher': d.get('publisher'), | ||
'target_os_type': d.get('target_os_type'), | ||
'title': d.get('title') | ||
} | ||
return d | ||
|
||
|
||
def main(): | ||
AzureRMArtifactFacts() | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lab_name not required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indeed, I wonder why it wasn't caught by sanity tests.....