Skip to content
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.

Sign up for GitHub

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

extend auth option deprecations to v0.12.0 #108

Merged
merged 2 commits into from
Oct 8, 2023
Merged

extend auth option deprecations to v0.12.0 #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ada85c4
extend auth option deprecations to v0.12.0
briantist Oct 8, 2023
a839c1e
add changelog fragment
briantist Oct 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions changelogs/fragments/108-auth-deprecation-extension.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
deprecated_features:
- The default value of the new ``GALAXY_AUTH_TYPE`` configuration option, added in this release, will change from ``api_key`` to ``access_token`` in ``v0.12.0`` (https://github.com/briantist/galactory/pull/77).
- The ``PREFER_CONFIGURED_KEY`` configuration option has been replaced by ``PREFER_CONFIGURED_AUTH`` and the old name will be removed in ``v0.12.0`` (https://github.com/briantist/galactory/pull/77).
- The ``USE_GALAXY_KEY`` configuration option has been replaced by ``USE_GALAXY_AUTH`` and the old name will be removed in ``v0.12.0`` (https://github.com/briantist/galactory/pull/77).
- The ``PUBLISH_SKIP_CONFIGURED_KEY`` configuration option has been replaced by ``PUBLISH_SKIP_CONFIGURED_AUTH`` and the old name will be removed in ``v0.12.0`` (https://github.com/briantist/galactory/pull/77).
22 changes: 11 additions & 11 deletions galactory/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,12 @@
parser.add_argument('--artifactory-path', type=str, required=True, env_var='GALACTORY_ARTIFACTORY_PATH', help='The URL of the path in Artifactory where collections are stored.')
parser.add_argument('--artifactory-api-key', type=str, env_var='GALACTORY_ARTIFACTORY_API_KEY', help='If set, is the API key used to access Artifactory. If set with artifactory-access-token, this value will not be used.')
parser.add_argument('--artifactory-access-token', type=str, env_var='GALACTORY_ARTIFACTORY_ACCESS_TOKEN', help='If set, is the Access Token used to access Artifactory. If set with artifactory-api-key, this value will be used and the API key will be ignored.')
parser.add_argument('--use-galaxy-key', action='store_true', env_var='GALACTORY_USE_GALAXY_KEY', help='If set, uses the Galaxy token sent in the request as the Artifactory auth. DEPRECATED: This option will be removed in v0.11.0. Please use --use-galaxy-auth going forward.')
parser.add_argument('--use-galaxy-key', action='store_true', env_var='GALACTORY_USE_GALAXY_KEY', help='If set, uses the Galaxy token sent in the request as the Artifactory auth. DEPRECATED: This option will be removed in v0.12.0. Please use --use-galaxy-auth going forward.')

Check warning on line 78 in galactory/__init__.py

View check run for this annotation

Codecov / codecov/patch

galactory/__init__.py#L78 

Added line #L78 was not covered by tests
parser.add_argument('--use-galaxy-auth', action='store_true', env_var='GALACTORY_USE_GALAXY_AUTH', help='If set, uses the Galaxy token sent in the request as the Artifactory auth.')
parser.add_argument('--galaxy-auth-type', type=str, env_var='GALACTORY_GALAXY_AUTH_TYPE', choices=['api_key', 'access_token'], help='Auth received via a Galaxy request should be interpreted as this type of auth.')
parser.add_argument('--prefer-configured-key', action='store_true', env_var='GALACTORY_PREFER_CONFIGURED_KEY', help='If set, prefer the confgured Artifactory auth over the Galaxy token. DEPRECATED: This option will be removed in v0.11.0. Please use --prefer-configured-auth going forward.')
parser.add_argument('--prefer-configured-key', action='store_true', env_var='GALACTORY_PREFER_CONFIGURED_KEY', help='If set, prefer the confgured Artifactory auth over the Galaxy token. DEPRECATED: This option will be removed in v0.12.0. Please use --prefer-configured-auth going forward.')

Check warning on line 81 in galactory/__init__.py

View check run for this annotation

Codecov / codecov/patch

galactory/__init__.py#L81 

Added line #L81 was not covered by tests
parser.add_argument('--prefer-configured-auth', action='store_true', env_var='GALACTORY_PREFER_CONFIGURED_AUTH', help='If set, prefer the confgured Artifactory auth over the Galaxy token.')
parser.add_argument('--publish-skip-configured-key', action='store_true', env_var='GALACTORY_PUBLISH_SKIP_CONFIGURED_KEY', help='If set, publish endpoint will not use configured auth, only auth included in a Galaxy request. DEPRECATED: This option will be removed in v0.11.0. Please use --publish-skip-configured-auth going forward.')
parser.add_argument('--publish-skip-configured-key', action='store_true', env_var='GALACTORY_PUBLISH_SKIP_CONFIGURED_KEY', help='If set, publish endpoint will not use configured auth, only auth included in a Galaxy request. DEPRECATED: This option will be removed in v0.12.0. Please use --publish-skip-configured-auth going forward.')

Check warning on line 83 in galactory/__init__.py

View check run for this annotation

Codecov / codecov/patch

galactory/__init__.py#L83 

Added line #L83 was not covered by tests
parser.add_argument('--publish-skip-configured-auth', action='store_true', env_var='GALACTORY_PUBLISH_SKIP_CONFIGURED_AUTH', help='If set, publish endpoint will not use configured auth, only auth included in a Galaxy request.')
parser.add_argument('--log-file', type=str, env_var='GALACTORY_LOG_FILE', help='If set, logging will go to this file instead of the console.')
parser.add_argument(
Expand Down Expand Up @@ -108,49 +108,49 @@

logging.basicConfig(filename=args.log_file, level=args.log_level)

# TODO: v0.11.0 - remove conditional old name
# TODO: v0.12.0 - remove conditional old name
if args.use_galaxy_key and not args.use_galaxy_auth:
use_galaxy_auth = True
warnings.warn(
message=(
"USE_GALAXY_KEY has been replaced by USE_GALAXY_AUTH and the old name will be removed in v0.11.0."
"USE_GALAXY_KEY has been replaced by USE_GALAXY_AUTH and the old name will be removed in v0.12.0."
" To suppress this warning, set USE_GALAXY_AUTH."
), category=DeprecationWarning, stacklevel=2
)
else:
use_galaxy_auth = args.use_galaxy_auth

# TODO: v0.11.0 - remove conditional & warning, set default on argument
# TODO: v0.12.0 - remove conditional & warning, set default on argument
if args.galaxy_auth_type is None and use_galaxy_auth:
galaxy_auth_type = 'api_key'
warnings.warn(
message=(
"USE_GALAXY_AUTH is True but GALAXY_AUTH_TYPE is not set."
" The default value used will be 'api_key' for backward compatibility, but will change to 'access_token' in v0.11.0."
" The default value used will be 'api_key' for backward compatibility, but will change to 'access_token' in v0.12.0."
" To suppress this warning, set an explicit value."
), category=FutureWarning, stacklevel=2
)
else:
galaxy_auth_type = args.galaxy_auth_type

# TODO: v0.11.0 - remove conditional old name
# TODO: v0.12.0 - remove conditional old name
if args.prefer_configured_key and not args.prefer_configured_auth:
prefer_configured_auth = True
warnings.warn(
message=(
"PREFER_CONFIGURED_KEY has been replaced by PREFER_CONFIGURED_AUTH and the old name will be removed in v0.11.0."
"PREFER_CONFIGURED_KEY has been replaced by PREFER_CONFIGURED_AUTH and the old name will be removed in v0.12.0."
" To suppress this warning, set PREFER_CONFIGURED_AUTH."
), category=DeprecationWarning, stacklevel=2
)
else:
prefer_configured_auth = args.prefer_configured_auth

# TODO: v0.11.0 - remove conditional old name
# TODO: v0.12.0 - remove conditional old name
if args.publish_skip_configured_key and not args.publish_skip_configured_auth:
publish_skip_configured_auth = True
warnings.warn(
message=(
"PUBLISH_SKIP_CONFIGURED_KEY has been replaced by PUBLISH_SKIP_CONFIGURED_AUTH and the old name will be removed in v0.11.0."
"PUBLISH_SKIP_CONFIGURED_KEY has been replaced by PUBLISH_SKIP_CONFIGURED_AUTH and the old name will be removed in v0.12.0."
" To suppress this warning, set PUBLISH_SKIP_CONFIGURED_AUTH."
), category=DeprecationWarning, stacklevel=2
)
Expand Down