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.

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

refactor!: rename creds -> auth, credentials -> authentication #199

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

AWS-Samuel
Copy link
Contributor

@AWS-Samuel AWS-Samuel commented Mar 6, 2024

  • rename cli "creds" option to "auth"
    • former: "deadline creds login/logout/status"
    • new: "deadline auth login/logout/status"
  • rename:
    • "DeadlineCredentialsStatus" -> "DeadlineAuthenticationStatus"
    • "DeadlineCredentialsStatusWidget" ->"DeadlineAuthenticationStatusWidget"
    • "AwsCredentialsType" -> "AwsCredentialsSource"
    • "AwsCredentialsStatus" -> "AwsAuthenticationStatus"

What was the problem/requirement? (What/Why)

An offline discussion resulted in a preference to using auth over creds for login/logout workflows.

What was the solution? (How)

Rename creds cli command to auth (breaking)

Also looked at a few of our APIs/public classes and renamed where it felt it made sense, most "credential" type/status were referring to if the user was authenticated to the service.

What is the impact of this change?

Big breaking change:

  • rename cli "creds" option to "auth"
    • former: "deadline creds login/logout/status"
    • new: "deadline auth login/logout/status"
  • rename:
    • "DeadlineCredentialsStatus" -> "DeadlineAuthenticationStatus"
    • "DeadlineCredentialsStatusWidget" ->"DeadlineAuthenticationStatusWidget"
    • "AwsCredentialsType" -> "AwsCredentialsSource"
    • "AwsCredentialsStatus" -> "AwsAuthenticationStatus"

Hopefully nicer name.

How was this change tested?

hatch run test

Ran CLI, confirmed it worked as expected

$ python3.9 -m deadline auth status
    Profile Name: (default)
          Source: HOST_PROVIDED
          Status: AUTHENTICATED
API Availability: True
$ python3.9 -m deadline auth status --output json
{"profile_name": "(default)", "source": "HOST_PROVIDED", "status": "AUTHENTICATED", "api_availability": true}

Ran GUI, confirmed it worked as expected

image

Was this change documented?

Not really, but will be in the change log.

Is this a breaking change?

YES

@AWS-Samuel AWS-Samuel marked this pull request as ready for review March 6, 2024 22:46
@AWS-Samuel AWS-Samuel requested a review from a team as a code owner March 6, 2024 22:46
@AWS-Samuel AWS-Samuel force-pushed the samuel/creds_auth_rename branch 9 times, most recently from d2dcf0f to cc510f7 Compare March 7, 2024 16:39
  - rename cli "creds" option to "auth"
      former: "deadline creds login/logout/status"
      new: "deadline auth login/logout/status"
  - rename:
       "DeadlineCredentialsStatus" -> "DeadlineAuthenticationStatus"
       "DeadlineCredentialsStatusWidget" ->"DeadlineAuthenticationStatusWidget"
       "AwsCredentialsType" -> "AwsCredentialsSource"
       "AwsCredentialsStatus" -> "AwsAuthenticationStatus"

Signed-off-by: Samuel Anderson <119458760+AWS-Samuel@users.noreply.github.com>
Comment on lines +109 to +111
kwargs["credentials_source"]
== AwsCredentialsSource.DEADLINE_CLOUD_MONITOR_LOGIN
):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's how black formatted it?! Interesting...

@ddneilson ddneilson merged commit 66126a1 into mainline Mar 7, 2024
18 checks passed
@ddneilson ddneilson deleted the samuel/creds_auth_rename branch March 7, 2024 18:57
npmacl pushed a commit that referenced this pull request Mar 21, 2024
- rename cli "creds" option to "auth"
      former: "deadline creds login/logout/status"
      new: "deadline auth login/logout/status"
  - rename:
       "DeadlineCredentialsStatus" -> "DeadlineAuthenticationStatus"
       "DeadlineCredentialsStatusWidget" ->"DeadlineAuthenticationStatusWidget"
       "AwsCredentialsType" -> "AwsCredentialsSource"
       "AwsCredentialsStatus" -> "AwsAuthenticationStatus"

**BREAKING CHANGE**
The `deadline creds` subcommand has been renamed to `deadline auth`

Signed-off-by: Samuel Anderson <119458760+AWS-Samuel@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants