Description

Counterpart to #2578

Adjustments to mocks for factors that were absent in the original overview: Update stored credentials check box and no authentication for public registries.

• Use more precise volcabulary: Replace registry which refers to Quay itself with repositories and also refer to images. From research online at docs.quay.io
• Minimize changes to documentation: Do not move Type and OAuth token fields from their current locations on the form.
• Replace front-end validation with information: Render Alert element (if editing which includes creating) preceding Update stored credentials field. It has Authentication as title. Conditionally render bullet items which are relevant for the type. Write the items in parallel form.
• Let backend behavior and request responses be source of truth: Especially because requirements for stored credentials are implicit instead of explicit, do not use radio buttons to select OAuth token versus robot accounts. Radio buttons are not relevant for all scenarios: For public repositories, neither stored credentials. For scanner, only token.

Changed files

1. Edit cypress/integration/integrations/imageIntegrations.test.js

   • Delete 'An OAuth token is required' assertion.

2. Edit src/Containers/Integrations/IntegrationForm/Forms/QuayIntegrationForm.tsx

   • Delete oauthToken from validationSchema object so backend is the single source of truth.
   • Add registryRobotCredentials: null property to defaultValues object.
   • Add hasInitialOauthToken and include it in the condition whether to render 'Currently-stored token will be used.' for placeholder of OAuth token.
   • Clear robot account password like oauthToken property.
   • Add special case for Quay integration, because unauthenticated is an implicit instead of explicit property.
   • Conditionally render Alert element if editing which includes creating.
   • Delete isRequired prop because Alert element explains the relationships.
   • Conditionally render Robot username and Robot password in a grid (as in some auth providers forms).
   • Include username in the condition whether to render 'Currently-stored password will be used.' for placeholder of Robot password.

3. Edit src/types/imageIntegration.proto.ts

   • Add registryRobotCredentials property to QuayConfig type.
   • Add QuayRobotAccount type.

Checklist

• Investigated and inspected CI test results
• Edited integration test

Testing Performed

With feature flag disabled

export ROX_QUAY_ROBOT_ACCOUNTS=false

1. View existing integration

   • OAuth token field with empty input box that is disabled. Response: registryRobotCredentials: null
     

   • Update stored credentials is ticked: OAuth token field with empty input box that is enabled.
     

With feature flag enabled

export ROX_QUAY_ROBOT_ACCOUNTS=true

Authentication

1. If editing, which includes creating, Authentication info alert renders relevant items:

   • Registry
     

   • Scanner
     

   • Registry + Scanner
     

Behavior

1. View existing integration

   • Registry: OAuth token Robot username Robot password fields with empty input boxes that are disabled, but username is not empty if there is a Robot account.
     

   • Scanner: OAuth token field with empty input box that is disabled.
     

   • Registry + Scanner: OAuth token Robot username Robot password fields with empty input boxes that are disabled, but username is not empty if there is a Robot account.
     

2. Create new integration: Relevant fields have empty input boxes that are enabled. For Type of Scanner, only OAuth token field is relevant.

   • Public repository: Leave empty. See properties in payload and response:

     oauthToken: "",
     registryRobotCredentials: null

     

   • Private repository: Enter stored credentials in relevant fields. See properties in payload and response:

     oauthToken: "token"
     registryRobotCredentials: {
         username: "namespace+accountname",
         password: "password"
     }

     

3. Edit existing integration

   • If initial values do not have stored credentials: Update stored credentials is unticked and relevant fields have empty input boxes that are disabled. For Type of Scanner, only OAuth token field is relevant.
     

   • If initial values do have stored credentials: Update stored credentials is ticked and relevant fields have empty input boxes that are enabled, but username is not empty if there is a Robot account. For Type of Scanner, only OAuth token field is relevant.
     

   • Edge case: Update stored credentials is ticked and delete Username with intent to change from authenticated to unauthenticated:

     registryRobotCredentials: {
         username: "",
         password: ""
     }

     Maybe would need registryRobotCredentials: null instead, because interpreted as incomplete request to update stored credentials. At least it demonstrates that form displays error message.