Merge branch 'feature/add-copyable-login-with-copy-to-empty-container-registry-view' into 'master'

Adds login input with copy box and supporting copy to empty container registry view

Closes #32866

See merge request gitlab-org/gitlab!18244

app/assets/javascripts/registry/components/app.vue

@@ -15,15 +15,19 @@ export default {
     GlLoadingIcon,
   },
   props: {
-    endpoint: {
-      type: String,
-      required: true,
-    },
     characterError: {
       type: Boolean,
       required: false,
       default: false,
     },
+    containersErrorImage: {
+      type: String,
+      required: true,
+    },
+    endpoint: {
+      type: String,
+      required: true,
+    },
     helpPagePath: {
       type: String,
       required: true,
@@ -32,7 +36,11 @@ export default {
       type: String,
       required: true,
     },
-    containersErrorImage: {
+    personalAccessTokensHelpLink: {
+      type: String,
+      required: true,
+    },
+    registryHostUrlWithPort: {
       type: String,
       required: true,
     },
@@ -40,6 +48,10 @@ export default {
       type: String,
       required: true,
     },
+    twoFactorAuthHelpLink: {
+      type: String,
+      required: true,
+    },
   },
   store,
   computed: {
@@ -79,6 +91,26 @@ export default {
         false,
       );
     },
+    notLoggedInToRegistryText() {
+      return sprintf(
+        s__(`ContainerRegistry|If you are not already logged in, you need to authenticate to
+             the Container Registry by using your GitLab username and password. If you have
+             %{twofaDocLinkStart}Two-Factor Authentication%{twofaDocLinkEnd} enabled, use a
+             %{personalAccessTokensDocLinkStart}Personal Access Token
+             %{personalAccessTokensDocLinkEnd}instead of a password.`),
+        {
+          twofaDocLinkStart: `<a href="${this.twoFactorAuthHelpLink}" target="_blank">`,
+          twofaDocLinkEnd: '</a>',
+          personalAccessTokensDocLinkStart: `<a href="${this.personalAccessTokensHelpLink}" target="_blank">`,
+          personalAccessTokensDocLinkEnd: '</a>',
+        },
+        false,
+      );
+    },
+    dockerLoginCommand() {
+      // eslint-disable-next-line @gitlab/i18n/no-non-i18n-strings
+      return `docker login ${this.registryHostUrlWithPort}`;
+    },
     dockerBuildCommand() {
       // eslint-disable-next-line @gitlab/i18n/no-non-i18n-strings
       return `docker build -t ${this.repositoryUrl} .`;
@@ -130,6 +162,17 @@ export default {
       <template #description>
         <p class="js-no-container-images-text" v-html="noContainerImagesText"></p>
         <h5>{{ s__('ContainerRegistry|Quick Start') }}</h5>
+        <p class="js-not-logged-in-to-registry-text" v-html="notLoggedInToRegistryText"></p>
+        <div class="input-group append-bottom-10">
+          <input :value="dockerLoginCommand" type="text" class="form-control monospace" readonly />
+          <span class="input-group-append">
+            <clipboard-button
+              :text="dockerLoginCommand"
+              :title="s__('ContainerRegistry|Copy login command')"
+              class="input-group-text"
+            />
+          </span>
+        </div>
         <p>
           {{
             s__(

app/assets/javascripts/registry/index.js

@@ -13,23 +13,29 @@ export default () =>
     data() {
       const { dataset } = document.querySelector(this.$options.el);
       return {
-        endpoint: dataset.endpoint,
         characterError: Boolean(dataset.characterError),
+        containersErrorImage: dataset.containersErrorImage,
+        endpoint: dataset.endpoint,
         helpPagePath: dataset.helpPagePath,
         noContainersImage: dataset.noContainersImage,
-        containersErrorImage: dataset.containersErrorImage,
+        personalAccessTokensHelpLink: dataset.personalAccessTokensHelpLink,
+        registryHostUrlWithPort: dataset.registryHostUrlWithPort,
         repositoryUrl: dataset.repositoryUrl,
+        twoFactorAuthHelpLink: dataset.twoFactorAuthHelpLink,
       };
     },
     render(createElement) {
       return createElement('registry-app', {
         props: {
-          endpoint: this.endpoint,
           characterError: this.characterError,
+          containersErrorImage: this.containersErrorImage,
+          endpoint: this.endpoint,
           helpPagePath: this.helpPagePath,
           noContainersImage: this.noContainersImage,
-          containersErrorImage: this.containersErrorImage,
+          personalAccessTokensHelpLink: this.personalAccessTokensHelpLink,
+          registryHostUrlWithPort: this.registryHostUrlWithPort,
           repositoryUrl: this.repositoryUrl,
+          twoFactorAuthHelpLink: this.twoFactorAuthHelpLink,
         },
       });
     },

app/helpers/application_helper.rb

@@ -108,6 +108,11 @@ module ApplicationHelper
     Gitlab.config.extra
   end
 
+  # shortcut for gitlab registry config
+  def registry_config
+    Gitlab.config.registry
+  end
+
   # Render a `time` element with Javascript-based relative date and tooltip
   #
   # time       - Time object

app/views/projects/registry/repositories/index.html.haml

@@ -5,7 +5,10 @@
     .col-12
       #js-vue-registry-images{ data: { endpoint: project_container_registry_index_path(@project, format: :json),
         "help_page_path" => help_page_path('user/packages/container_registry/index'),
+        "two_factor_auth_help_link" => help_page_path('user/profile/account/two_factor_authentication'),
+        "personal_access_tokens_help_link" => help_page_path('user/profile/personal_access_tokens'),
         "no_containers_image" => image_path('illustrations/docker-empty-state.svg'),
         "containers_error_image" => image_path('illustrations/docker-error-state.svg'),
         "repository_url" => escape_once(@project.container_registry_url),
+        "registry_host_url_with_port" => escape_once(registry_config.host_port),
         character_error: @character_error.to_s } }

changelogs/unreleased/feature-add-copyable-login-with-copy-to-empty-container-registry-view.yml

+---
+title: Adds login input with copy box and supporting copy to empty container registry view
+merge_request: 18244
+author: nate geslin
+type: added

locale/gitlab.pot

@@ -4349,12 +4349,18 @@ msgstr ""
 msgid "ContainerRegistry|Copy build command"
 msgstr ""
 
+msgid "ContainerRegistry|Copy login command"
+msgstr ""
+
 msgid "ContainerRegistry|Copy push command"
 msgstr ""
 
 msgid "ContainerRegistry|Docker connection error"
 msgstr ""
 
+msgid "ContainerRegistry|If you are not already logged in, you need to authenticate to the Container Registry by using your GitLab username and password. If you have %{twofaDocLinkStart}Two-Factor Authentication%{twofaDocLinkEnd} enabled, use a %{personalAccessTokensDocLinkStart}Personal Access Token %{personalAccessTokensDocLinkEnd}instead of a password."
+msgstr ""
+
 msgid "ContainerRegistry|Last Updated"
 msgstr ""
 

spec/frontend/registry/components/app_spec.js

-import registry from '~/registry/components/app.vue';
 import { mount } from '@vue/test-utils';
+import registry from '~/registry/components/app.vue';
 import { TEST_HOST } from '../../helpers/test_constants';
 import { reposServerResponse, parsedReposServerResponse } from '../mock_data';
 
@@ -8,6 +8,7 @@ describe('Registry List', () => {
 
   const findCollapsibleContainer = w => w.findAll({ name: 'CollapsibeContainerRegisty' });
   const findNoContainerImagesText = w => w.find('.js-no-container-images-text');
+  const findNotLoggedInToRegistryText = w => w.find('.js-not-logged-in-to-registry-text');
   const findSpinner = w => w.find('.gl-spinner');
   const findCharacterErrorText = w => w.find('.js-character-error-text');
 
@@ -17,6 +18,9 @@ describe('Registry List', () => {
     noContainersImage: 'foo',
     containersErrorImage: 'foo',
     repositoryUrl: 'foo',
+    registryHostUrlWithPort: 'foo',
+    personalAccessTokensHelpLink: 'foo',
+    twoFactorAuthHelpLink: 'foo',
   };
 
   const setMainEndpoint = jest.fn();
@@ -67,6 +71,13 @@ describe('Registry List', () => {
         'With the Container Registry, every project can have its own space to store its Docker images. More Information',
       );
     });
+
+    it('should render login help text', () => {
+      const notLoggedInToRegistryText = findNotLoggedInToRegistryText(localWrapper);
+      expect(notLoggedInToRegistryText.text()).toEqual(
+        'If you are not already logged in, you need to authenticate to the Container Registry by using your GitLab username and password. If you have Two-Factor Authentication enabled, use a Personal Access Token instead of a password.',
+      );
+    });
   });
 
   describe('while loading data', () => {