`azure_rm_adapplication_info` - Feature azure rm adapplication info diff #1560

TheNotoriousRMM · 2024-05-15T09:44:22Z

SUMMARY

azure_rm_adapplication_info add option "app_diff" #1559

ISSUE TYPE

Bugfix Pull Request
Docs Pull Request
Feature Pull Request

COMPONENT NAME

azure_rm_adapplication_info.py
test targets > azure_rm_adapplication > tasks: main

ADDITIONAL INFORMATION

DOCUMENTATION = '''
options:
    app_diff:
        description:
            - The application Name or the app id.
        type: list
        elements: dict

app_diff hinzugefügt

Anpassungen

Finalizing modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Add tests for app_diff

modify doc for sentry test

…ation_info_diff

documentation modify examples

Fred-sun

@TheNotorioursRMM Please take a look, Small change request! Thanks!

Fred-sun · 2024-05-16T03:17:09Z

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

+
+- name: Assert the difference
+  ansible.builtin.assert:
+    that: diff_output.app_diff[0].app_display_name == "{{ display_name }}"


Wrong indentation: expected 6 but found 8

I don't understand this issue..
The indentaton is the same as in line 84, 85 and 86?

Fred-sun · 2024-05-16T03:17:24Z

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

@@ -94,4 +104,4 @@
 - name: Assert there is no application
  ansible.builtin.assert:
    that:
-      - output.applications | length == 0
+      - output.applications | length == 0


No new line character at the end of file

New commit: Fixed in 1 line.

Fred-sun · 2024-05-16T07:37:50Z

plugins/modules/azure_rm_adapplication_info.py

@@ -149,7 +229,8 @@ def __init__(self):
            app_id=dict(type='str'),
            object_id=dict(type='str'),
            identifier_uri=dict(type='str'),
-            app_display_name=dict(type='str')
+            app_display_name=dict(type='str'),
+            app_diff=dict(type='list', elements='dict')


If defined this way, it will be easier to understand!

Suggested change

app_diff=dict(type='list', elements='dict')

app_diff=dict(type='list',

elements='dict',

options=dict(

app_id=dict(type='str'),

app_display_name=dict(type='str')

)

)

If I have the configuration of my adapps in a YAML or JSON file, I don't want to edit it additionally. I want to provide it directly to the plugin, not just the "app_display_name" or the "app_id". However, if I provide this as an option, I have to filter the YAML or JSON for these two options, which means another Ansible task in the playbook.

But your code only handles these two fields and no other fields?

My code need one of these fields, the other fields will be ignored. In the future with this way, it's possible to check the diffrence of any field and to update them.
So I can write the full config for the AD App by code, check it with the app_diff option and create, update or delete the applications with the existing module "azure_rm_adapplication.py".

Yes, that is correct. The code only handles these two fields. However, I can provide a YAML or JSON that contains the entire content of multiple ADAPPs in a list without it being blocked. This way, I can directly compare my stored configuration of the ADAPPs without having to parse it again, create a list, and pass the values into a variable

Fred-sun · 2024-05-16T07:43:51Z

plugins/modules/azure_rm_adapplication_info.py

+                    if app.get("app_id") == diff.get("app_id") or app.get("app_display_name") == diff.get("app_display_name"):
+                        found = True
+                        break
+                if not found:


Is this a definition error? Add to 'app_diff' if it should be True! Thank you!

Suggested change

if not found:

if found:

No, that is correct. It compares the provided list with the production Azure data, and if something is not present in the production environment, the status "absent" is added. This way, you can immediately reuse the return to delete the adapps that do not belong in the production environment using "plugins/modules/azure_rm_adapplication.py".
This allows you to first add adapps with "plugins/modules/azure_rm_adapplication.py" and then use "plugins/modules/azure_rm_adapplication_info.py" (option diff) to identify the adapps that should not be in the live environment and subsequently delete them with "plugins/modules/azure_rm_adapplication.py".

Understood, please fix the following error, and make a detailed definition of the parameter definition. Thank you!

I have adjusted the documentation and re-added the NOT.

Fred-sun · 2024-05-21T03:06:51Z

kindly ping!

….yml Fix: No new line character at the end of file

Fred-sun · 2024-05-22T06:12:00Z

@TheNotoriousRMM Please help solve the conflicts I will review and push forward the merger as soon as possible. Thank you!

Fred-sun

small change request!

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

Fred-sun · 2024-05-31T08:59:36Z

plugins/modules/azure_rm_adapplication_info.py

+- name: get ad app diff ---- by display name
+  azure_rm_adapplication_info:
+    app_diff:
+        - app_display_name: "{{ display_name }}"


Wrong indentation: expected 6 but found 8

Fix wrong indentation

Fred-sun · 2024-05-31T08:59:42Z

plugins/modules/azure_rm_adapplication_info.py

+  azure_rm_adapplication_info:
+    app_diff:
+        - app_display_name: "{{ display_name }}"
+        - app_id: "{{ app_id }}"


Wrong indentation: expected 6 but found 8

Fred-sun · 2024-05-31T09:01:58Z

plugins/modules/azure_rm_adapplication_info.py

+                    if app.get("app_id") == diff.get("app_id") or app.get("app_display_name") == diff.get("app_display_name"):
+                        found = True
+                        break
+                if not found:


Understood, please fix the following error, and make a detailed definition of the parameter definition. Thank you!

Add new documentation for the option app_diff

Fix wrong indentation

…ation_info_diff

therapac · 2024-06-05T08:59:06Z

plugins/modules/azure_rm_adapplication_info.py

@@ -149,7 +229,8 @@ def __init__(self):
            app_id=dict(type='str'),
            object_id=dict(type='str'),
            identifier_uri=dict(type='str'),
-            app_display_name=dict(type='str')
+            app_display_name=dict(type='str'),
+            app_diff=dict(type='list', elements='dict')


Yes, that is correct. The code only handles these two fields. However, I can provide a YAML or JSON that contains the entire content of multiple ADAPPs in a list without it being blocked. This way, I can directly compare my stored configuration of the ADAPPs without having to parse it again, create a list, and pass the values into a variable

therapac · 2024-06-05T11:25:38Z

plugins/modules/azure_rm_adapplication_info.py

+                    if app.get("app_id") == diff.get("app_id") or app.get("app_display_name") == diff.get("app_display_name"):
+                        found = True
+                        break
+                if not found:


I have adjusted the documentation and re-added the NOT.

therapac · 2024-06-05T11:38:35Z

plugins/modules/azure_rm_adapplication_info.py

+- name: get ad app diff ---- by display name
+  azure_rm_adapplication_info:
+    app_diff:
+        - app_display_name: "{{ display_name }}"


Fix wrong indentation

Fred-sun

Please!

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

I hope this will resolve the issue. Co-authored-by: Fred-sun <37327967+Fred-sun@users.noreply.github.com>

TheNotoriousRMM

Change accepted

TheNotoriousRMM · 2024-05-21T07:06:55Z

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

@@ -94,4 +104,4 @@
 - name: Assert there is no application
  ansible.builtin.assert:
    that:
-      - output.applications | length == 0
+      - output.applications | length == 0


New commit: Fixed in 1 line.

TheNotoriousRMM · 2024-05-21T07:15:26Z

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

+
+- name: Assert the difference
+  ansible.builtin.assert:
+    that: diff_output.app_diff[0].app_display_name == "{{ display_name }}"


I don't understand this issue..
The indentaton is the same as in line 84, 85 and 86?

TheNotoriousRMM · 2024-05-21T13:42:07Z

plugins/modules/azure_rm_adapplication_info.py

@@ -149,7 +229,8 @@ def __init__(self):
            app_id=dict(type='str'),
            object_id=dict(type='str'),
            identifier_uri=dict(type='str'),
-            app_display_name=dict(type='str')
+            app_display_name=dict(type='str'),
+            app_diff=dict(type='list', elements='dict')


My code need one of these fields, the other fields will be ignored. In the future with this way, it's possible to check the diffrence of any field and to update them.
So I can write the full config for the AD App by code, check it with the app_diff option and create, update or delete the applications with the existing module "azure_rm_adapplication.py".

Fred-sun · 2024-06-14T06:39:28Z

tests/integration/targets/azure_rm_adapplication/tasks/main.yml

@@ -104,4 +121,4 @@
 - name: Assert there is no application
  ansible.builtin.assert:
    that:
-      - output.applications | length == 0
+      output.applications | length == 0


Same error!

Suggested change

output.applications | length == 0

ansible.builtin.assert:

that: output.applications | length == 0

Resolved in a new push

…ation_info_diff

….yml Change No new line character at the end of file

TheNotoriousRMM

I have fix line 124

Fred-sun · 2024-06-26T15:10:52Z

@TheNotoriousRMM sanity tests still don't work, depending on the editor you're using. The error is as follows:

yaml[new-line-at-end-of-file]: No new line character at the end of file
tests/integration/targets/azure_rm_adapplication/tasks/main.yml:123

yaml[new-line-at-end-of-file] basic   formatting, yaml

Fred-sun · 2024-06-26T15:12:44Z

@TheNotoriousRMM Since you did not make any changes in the last line, can you try to undo the changes in the last line? Thank you!

….yml Undo changes at the last line. Sanity test was OK.

TheNotoriousRMM

I have undo the changes at the last line. Sanity check was OK.

Fred-sun · 2024-06-27T14:24:37Z

@TheNotoriousRMM However, judging from the PR content you submitted, you added new lines at the end of the play, as shown below:

TheNotoriousRMM · 2024-06-28T07:53:55Z

@TheNotoriousRMM However, judging from the PR content you submitted, you added new lines at the end of the play, as shown below:

I'm confused.. Can you give me a hint how I can delete this line?
In my GitHub Repo I have no new line at the end of the file:

Fred-sun · 2024-06-28T12:27:44Z

@TheNotoriousRMM You can avoid this problem by moving the mouse over the last line（vim edit the file and enter insert mode), pressing the 'ESC' key to cancel the new line at the tail and then save, I did this in PR #1616 and the tail line disappeared, sanity pass! Thank you!

….yml Add new line at the end of the file. Opened in vim and save, the new line automaticly added.

TheNotoriousRMM · 2024-07-02T09:00:27Z

@Fred-sun I have finaly added a new line at the end of the file. Sorry, I thought the last line had to be deleted and not added. I didn't understand you correctly ;)
Hope the file looks good now.

Fred-sun · 2024-07-02T15:55:34Z

@TheNotoriousRMM Thanks for you update! Everything is OK! I will push for merged as soon as possible!

* modified: plugins/modules/azure_rm_adapplication_info.py * modified: plugins/modules/azure_rm_adapplication_info.py app_diff hinzugefügt * modified: plugins/modules/azure_rm_adapplication_info.py Anpassungen * Anpassungen * Anpassungen * modified: plugins/modules/azure_rm_adapplication_info.py Finalizing modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Add tests for app_diff * modified: plugins/modules/azure_rm_adapplication_info.py modify doc for sentry test * modified: plugins/modules/azure_rm_adapplication_info.py documentation modify examples * modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Fix: No new line character at the end of file * modified: plugins/modules/azure_rm_adapplication_info.py Add new documentation for the option app_diff * modified: plugins/modules/azure_rm_adapplication_info.py Fix wrong indentation * Update tests/integration/targets/azure_rm_adapplication/tasks/main.yml I hope this will resolve the issue. Co-authored-by: Fred-sun <37327967+Fred-sun@users.noreply.github.com> * modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Change No new line character at the end of file * modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Undo changes at the last line. Sanity test was OK. * modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Add new line at the end of the file. Opened in vim and save, the new line automaticly added. --------- Co-authored-by: MehrR <raphael.mehr@stadtluzern.ch> Co-authored-by: baechir <raphael.baechi@stadtluzern.ch> Co-authored-by: TheRapac <55585899+therapac@users.noreply.github.com> Co-authored-by: Fred-sun <37327967+Fred-sun@users.noreply.github.com>

MehrR and others added 9 commits May 2, 2024 14:07

modified: plugins/modules/azure_rm_adapplication_info.py

6603c4b

modified: plugins/modules/azure_rm_adapplication_info.py

2b452a3

app_diff hinzugefügt

modified: plugins/modules/azure_rm_adapplication_info.py

46e95b1

Anpassungen

Anpassungen

bf011af

Anpassungen

774e0fb

modified: plugins/modules/azure_rm_adapplication_info.py

9143df6

Finalizing modified: tests/integration/targets/azure_rm_adapplication/tasks/main.yml Add tests for app_diff

modified: plugins/modules/azure_rm_adapplication_info.py

944b9b4

modify doc for sentry test

Merge branch 'ansible-collections:dev' into feature_azure_rm_adapplic…

886021f

…ation_info_diff

modified: plugins/modules/azure_rm_adapplication_info.py

5bbfe53

documentation modify examples

Fred-sun reviewed May 16, 2024

View reviewed changes

Fred-sun added question Further information is requested medium_priority Medium priority work in In trying to solve, or in working with contributors labels May 16, 2024

modified: tests/integration/targets/azure_rm_adapplication/tasks/main…

4a13a10

….yml Fix: No new line character at the end of file

Merge branch 'dev' into feature_azure_rm_adapplication_info_diff

f62a2fc

Fred-sun reviewed May 31, 2024

View reviewed changes

therapac and others added 3 commits June 5, 2024 11:40

modified: plugins/modules/azure_rm_adapplication_info.py

f06e9db

Add new documentation for the option app_diff

modified: plugins/modules/azure_rm_adapplication_info.py

dca54f2

Fix wrong indentation

Merge branch 'ansible-collections:dev' into feature_azure_rm_adapplic…

ac79aad

…ation_info_diff

therapac approved these changes Jun 5, 2024

View reviewed changes

Fred-sun reviewed Jun 13, 2024

View reviewed changes

tests/integration/targets/azure_rm_adapplication/tasks/main.yml Outdated Show resolved Hide resolved

Update tests/integration/targets/azure_rm_adapplication/tasks/main.yml

b41c5e4

I hope this will resolve the issue. Co-authored-by: Fred-sun <37327967+Fred-sun@users.noreply.github.com>

TheNotoriousRMM commented Jun 13, 2024

View reviewed changes

Fred-sun reviewed Jun 14, 2024

View reviewed changes

TheNotoriousRMM and others added 2 commits June 26, 2024 15:01

Merge branch 'ansible-collections:dev' into feature_azure_rm_adapplic…

870d950

…ation_info_diff

modified: tests/integration/targets/azure_rm_adapplication/tasks/main…

5eb8ee7

….yml Change No new line character at the end of file

TheNotoriousRMM commented Jun 26, 2024

View reviewed changes

modified: tests/integration/targets/azure_rm_adapplication/tasks/main…

6b34872

….yml Undo changes at the last line. Sanity test was OK.

TheNotoriousRMM commented Jun 27, 2024

View reviewed changes

modified: tests/integration/targets/azure_rm_adapplication/tasks/main…

57a6cf2

….yml Add new line at the end of the file. Opened in vim and save, the new line automaticly added.

Fred-sun added ready_for_review The PR has been modified and can be reviewed and merged and removed work in In trying to solve, or in working with contributors labels Jul 2, 2024

Fred-sun assigned xuzhang3 Jul 2, 2024

xuzhang3 approved these changes Jul 3, 2024

View reviewed changes

xuzhang3 merged commit 2c9aeab into ansible-collections:dev Jul 3, 2024

TheNotoriousRMM deleted the feature_azure_rm_adapplication_info_diff branch July 4, 2024 06:30

xuzhang3 changed the title ~~Feature azure rm adapplication info diff~~ azure_rm_adapplication_info - Feature azure rm adapplication info diff Aug 30, 2024

	output.applications \| length == 0
	ansible.builtin.assert:
	that: output.applications \| length == 0

azure_rm_adapplication_info - Feature azure rm adapplication info diff #1560

azure_rm_adapplication_info - Feature azure rm adapplication info diff #1560

Conversation

TheNotoriousRMM commented May 15, 2024

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Fred-sun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fred-sun commented May 21, 2024

Fred-sun commented May 22, 2024

Fred-sun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fred-sun left a comment

Choose a reason for hiding this comment

TheNotoriousRMM left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheNotoriousRMM left a comment

Choose a reason for hiding this comment

Fred-sun commented Jun 26, 2024

Fred-sun commented Jun 26, 2024

TheNotoriousRMM left a comment

Choose a reason for hiding this comment

Fred-sun commented Jun 27, 2024

TheNotoriousRMM commented Jun 28, 2024

Fred-sun commented Jun 28, 2024 • edited Loading

TheNotoriousRMM commented Jul 2, 2024

Fred-sun commented Jul 2, 2024

`azure_rm_adapplication_info` - Feature azure rm adapplication info diff #1560

`azure_rm_adapplication_info` - Feature azure rm adapplication info diff #1560

Fred-sun commented Jun 28, 2024 •

edited

Loading