bitbucket: Support Basic Auth #2045

maxbrunet · 2021-03-19T04:15:16Z

SUMMARY

Support Basic Auth

TODO:

Add support for Basic Auth in module util
Settle on usage of username parameter (and potentially on how migrate/deprecate as needed)
- ~~Option 1. Rename current username to workspace to follow API semantic (that did confuse me at first as my company is not a username)~~
- Option 2. Use user for Basic Auth username (risk to be confusing, deprecate current usage of username)
- ~~Option 3. ?~~
Update modules documentation accordingly
Update tests
Anything else?

Close #2044

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

bitbucket_access_key
bitbucket_pipeline_key_pair
bitbucket_pipeline_known_host
bitbucket_pipeline_variable

ADDITIONAL INFORMATION

Bitbucket API - Authentication methods:
https://developer.atlassian.com/bitbucket/api/2/reference/meta/authentication#app-pw

maxbrunet · 2021-03-19T04:30:59Z

cc @catcombo

maxbrunet · 2021-03-21T19:50:32Z

Hey @felixfontein, I would need some advice on how to handle the username parameter here (please see description)? Are breaking changes allowed for the bitbucket_* modules (at least in the next major version)? Or what would be the best way around it like deprecation?

felixfontein · 2021-03-22T17:39:21Z

If username is changed to workspace, then username should be kept as an alias for backwards compatibility. Breaking changes are possible, but should really be avoided if they are not strictly necessary. In general, we announce breaking changes a long time in advance with deprecations.

ansibullbot · 2021-04-12T05:01:53Z

The test ansible-test sanity --test validate-modules [explain] failed with 8 errors:

plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test validate-modules [explain] failed with 8 errors:

plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test validate-modules [explain] failed with 8 errors:

plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation

The test ansible-test sanity --test validate-modules [explain] failed with 8 errors:

plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_access_key.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: parameter-type-not-in-doc: Argument 'password' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py:0:0: undocumented-parameter: Argument 'password' is listed in the argument_spec, but not documented in the module documentation

click here for bot help

russoz · 2021-04-19T10:24:56Z

Hi @maxbrunet if you could prepend [WIP] to this PR's title, the bot will add the WIP label, making it easier for us to spot it ;-)

(Also feel free to ask for help - here or in the IRC channel)

felixfontein · 2021-09-13T05:43:37Z

@maxbrunet do you still plan to work on this in the near future?

needs_info

maxbrunet · 2021-09-13T16:35:17Z

Not sure, maybe if I have time, but not really my priority, sorry

…own_host.py Co-authored-by: Felix Fontein <felix@fontein.de>

…riable.py Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>

…y_pair.py Co-authored-by: Felix Fontein <felix@fontein.de>

maxbrunet · 2021-10-30T18:41:55Z

Thank you for the review and suggestions @felixfontein

Since you don't allow maintainer edits

It must be because it is from a fork in my company's org, I do not have control over the setting, I will open PRs from my account next time.

I have documented the precedence between OAuth and Basic Auth credentials, it is usually how multiple credential sources are handled, but I considered making them mutually exclusive, I leave the patch here in case I have a change of mind.

mutually_exclusive.diff

diff --git a/plugins/module_utils/source_control/bitbucket.py b/plugins/module_utils/source_control/bitbucket.py
index bb50626a..4fa9ebc6 100644
--- a/plugins/module_utils/source_control/bitbucket.py
+++ b/plugins/module_utils/source_control/bitbucket.py
@@ -31,6 +31,10 @@ class BitbucketHelper:
             password=dict(type='str', no_log=True, fallback=(env_fallback, ['BITBUCKET_PASSWORD'])),
         )
 
+    @staticmethod
+    def bitbucket_mutually_exclusive():
+        return [[oauth, basic] for oauth in ["client_id", "client_secret"] for basic in ["user", "password"]]
+
     @staticmethod
     def bitbucket_required_one_of():
         return [['client_id', 'client_secret', 'user', 'password']]
diff --git a/plugins/modules/source_control/bitbucket/bitbucket_access_key.py b/plugins/modules/source_control/bitbucket/bitbucket_access_key.py
index 6451d729..94280e51 100644
--- a/plugins/modules/source_control/bitbucket/bitbucket_access_key.py
+++ b/plugins/modules/source_control/bitbucket/bitbucket_access_key.py
@@ -227,6 +227,7 @@ def main():
     module = AnsibleModule(
         argument_spec=argument_spec,
         supports_check_mode=True,
+        mutually_exclusive=BitbucketHelper.bitbucket_mutually_exclusive(),
         required_one_of=BitbucketHelper.bitbucket_required_one_of(),
         required_together=BitbucketHelper.bitbucket_required_together(),
     )
diff --git a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py
index 5d42419d..9d1703c7 100644
--- a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py
+++ b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py
@@ -164,6 +164,7 @@ def main():
     module = AnsibleModule(
         argument_spec=argument_spec,
         supports_check_mode=True,
+        mutually_exclusive=BitbucketHelper.bitbucket_mutually_exclusive(),
         required_one_of=BitbucketHelper.bitbucket_required_one_of(),
         required_together=BitbucketHelper.bitbucket_required_together(),
     )
diff --git a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py
index 9f4f2b94..2c93feea 100644
--- a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py
+++ b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py
@@ -265,6 +265,7 @@ def main():
     module = AnsibleModule(
         argument_spec=argument_spec,
         supports_check_mode=True,
+        mutually_exclusive=BitbucketHelper.bitbucket_mutually_exclusive(),
         required_one_of=BitbucketHelper.bitbucket_required_one_of(),
         required_together=BitbucketHelper.bitbucket_required_together(),
     )
diff --git a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py
index e5701184..b9458291 100644
--- a/plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py
+++ b/plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py
@@ -226,6 +226,7 @@ def main():
     module = BitBucketPipelineVariable(
         argument_spec=argument_spec,
         supports_check_mode=True,
+        mutually_exclusive=BitbucketHelper.bitbucket_mutually_exclusive(),
         required_one_of=BitbucketHelper.bitbucket_required_one_of(),
         required_together=BitbucketHelper.bitbucket_required_together(),
     )

felixfontein

Besides the two version_addeds below (sorry I missed them before), this needs a changelog fragment:

A minor_changes section for the new options (user, password);
A deprecated_features section for that username has been renamed to workspace and the old name username (now an alias) will be removed in community.general 6.0.0;
A major_changes entry that client_id is no longer marked as no_log=True. (major_changes so that this gets included in the porting guide; if anyone things their client_id is sensitive they need to take precautions to keep it out of logs - if it's announced that publicly nobody can complain :) ).

plugins/doc_fragments/bitbucket.py

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein

Some wording and formatting issues in the changelog:

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein

If CI doesn't come up with a surprise, I'll merge this :)

felixfontein · 2021-10-31T18:10:13Z

@maxbrunet thanks a lot for contributing this!

* bitbucket: Support Basic Auth * Rename username to user * Document user/password options * Rename username to workspace * Deprecate username * Fix credentials_required error_message * Fix credentials_required error_message * Test user/password/workspace options and env vars * Update a test to use user/password/workspace for each module * Fix check auth arguments * Use required_one_of/required_together * Fix required typo * Fix fetch_access_token * Fix tests 🤞 * Switch things up in test_bitbucket_access_key * Fix username/password are None * Remove username/password properties, use params directly * Update plugins/doc_fragments/bitbucket.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/module_utils/source_control/bitbucket.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/module_utils/source_control/bitbucket.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/module_utils/source_control/bitbucket.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_access_key.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_known_host.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_access_key.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_key_pair.py Co-authored-by: Felix Fontein <felix@fontein.de> * Document OAuth/Basic Auth precedence * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * Remove no_log=False from user argument * Add changelog fragment * Correct wording and formatting in changelog Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/2045-bitbucket_support_basic_auth.yaml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>

maxbrunet marked this pull request as draft March 19, 2021 04:16

ansibullbot added affects_2.10 community_review feature This issue/PR relates to a feature request module_utils module_utils needs_triage new_contributor Help guide this first time contributor plugins plugin (any type) labels Mar 19, 2021

This comment has been minimized.

Sign in to view

ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed community_review labels Mar 19, 2021

maxbrunet force-pushed the feature/bitbucket/basic-auth branch from c624557 to 4387c4b Compare April 12, 2021 04:51

ansibullbot added community_review and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Apr 12, 2021

ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed community_review labels Apr 12, 2021

russoz removed the needs_triage label Apr 19, 2021

felixfontein changed the title ~~bitbucket: Support Basic Auth~~ [WIP] bitbucket: Support Basic Auth Apr 19, 2021

ansibullbot added the WIP Work in progress label Apr 19, 2021

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label May 1, 2021

ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Jul 8, 2021

ansibullbot added the needs_info This issue requires further information. Please answer any outstanding questions label Sep 13, 2021

ansibullbot removed the needs_info This issue requires further information. Please answer any outstanding questions label Sep 13, 2021

maxbrunet and others added 6 commits October 30, 2021 11:10

Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_kn…

25872bf

…own_host.py Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_kn…

20caf28

…own_host.py Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_va…

c89a96d

…riable.py Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_va…

fa768c5

…riable.py Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/source_control/bitbucket/bitbucket_access_key.py

61c62bf

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/source_control/bitbucket/bitbucket_pipeline_ke…

a8e0b30

…y_pair.py Co-authored-by: Felix Fontein <felix@fontein.de>

Document OAuth/Basic Auth precedence

ffeffa8

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Oct 30, 2021

felixfontein reviewed Oct 30, 2021

View reviewed changes

plugins/doc_fragments/bitbucket.py Show resolved Hide resolved

plugins/doc_fragments/bitbucket.py Show resolved Hide resolved

maxbrunet and others added 3 commits October 30, 2021 13:40

Apply suggestions from code review

bcd2f66

Co-authored-by: Felix Fontein <felix@fontein.de>

Remove no_log=False from user argument

2b8585e

Add changelog fragment

ef594f3

felixfontein reviewed Oct 31, 2021

View reviewed changes

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml Outdated Show resolved Hide resolved

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml Outdated Show resolved Hide resolved

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml Outdated Show resolved Hide resolved

Correct wording and formatting in changelog

4974ef3

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein reviewed Oct 31, 2021

View reviewed changes

changelogs/fragments/2045-bitbucket_support_basic_auth.yaml Outdated Show resolved Hide resolved

Update changelogs/fragments/2045-bitbucket_support_basic_auth.yaml

2764655

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein approved these changes Oct 31, 2021

View reviewed changes

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 31, 2021

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Oct 31, 2021

felixfontein merged commit aaa0f39 into ansible-collections:main Oct 31, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bitbucket: Support Basic Auth #2045

bitbucket: Support Basic Auth #2045

maxbrunet commented Mar 19, 2021 •

edited

Loading

This comment has been minimized.

maxbrunet commented Mar 19, 2021

maxbrunet commented Mar 21, 2021

felixfontein commented Mar 22, 2021

ansibullbot commented Apr 12, 2021

russoz commented Apr 19, 2021

felixfontein commented Sep 13, 2021

maxbrunet commented Sep 13, 2021

maxbrunet commented Oct 30, 2021

felixfontein left a comment

felixfontein left a comment

felixfontein left a comment

felixfontein commented Oct 31, 2021

bitbucket: Support Basic Auth #2045

bitbucket: Support Basic Auth #2045

Conversation

maxbrunet commented Mar 19, 2021 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

This comment has been minimized.

maxbrunet commented Mar 19, 2021

maxbrunet commented Mar 21, 2021

felixfontein commented Mar 22, 2021

ansibullbot commented Apr 12, 2021

russoz commented Apr 19, 2021

felixfontein commented Sep 13, 2021

maxbrunet commented Sep 13, 2021

maxbrunet commented Oct 30, 2021

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein commented Oct 31, 2021

maxbrunet commented Mar 19, 2021 •

edited

Loading