Merge branch '212775-revert-deploy-keys-move' into 'master'

Move deploy keys section back to repository settings

See merge request gitlab-org/gitlab!29184

app/assets/javascripts/pages/projects/settings/ci_cd/show/index.js

@@ -3,7 +3,6 @@ import SecretValues from '~/behaviors/secret_values';
 import AjaxVariableList from '~/ci_variable_list/ajax_variable_list';
 import registrySettingsApp from '~/registry/settings/registry_settings_bundle';
 import initVariableList from '~/ci_variable_list';
-import initDeployKeys from '~/deploy_keys';
 
 document.addEventListener('DOMContentLoaded', () => {
   // Initialize expandable settings panels
@@ -41,5 +40,4 @@ document.addEventListener('DOMContentLoaded', () => {
   });
 
   registrySettingsApp();
-  initDeployKeys();
 });

app/assets/javascripts/pages/projects/settings/repository/form.js

@@ -3,6 +3,7 @@
 import ProtectedTagCreate from '~/protected_tags/protected_tag_create';
 import ProtectedTagEditList from '~/protected_tags/protected_tag_edit_list';
 import initSettingsPanels from '~/settings_panels';
+import initDeployKeys from '~/deploy_keys';
 import ProtectedBranchCreate from '~/protected_branches/protected_branch_create';
 import ProtectedBranchEditList from '~/protected_branches/protected_branch_edit_list';
 import DueDateSelectors from '~/due_date_select';
@@ -11,6 +12,7 @@ import fileUpload from '~/lib/utils/file_upload';
 export default () => {
   new ProtectedTagCreate();
   new ProtectedTagEditList();
+  initDeployKeys();
   initSettingsPanels();
   new ProtectedBranchCreate();
   new ProtectedBranchEditList();

app/controllers/projects/deploy_keys_controller.rb

 # frozen_string_literal: true
 
 class Projects::DeployKeysController < Projects::ApplicationController
+  include RepositorySettingsRedirect
   respond_to :html
 
   # Authorize
@@ -11,7 +12,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
 
   def index
     respond_to do |format|
-      format.html { redirect_to_ci_cd_settings }
+      format.html { redirect_to_repository }
       format.json do
         render json: Projects::Settings::DeployKeysPresenter.new(@project, current_user: current_user).as_json
       end
@@ -19,7 +20,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
   end
 
   def new
-    redirect_to_ci_cd_settings
+    redirect_to_repository
   end
 
   def create
@@ -29,7 +30,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
       flash[:alert] = @key.errors.full_messages.join(', ').html_safe
     end
 
-    redirect_to_ci_cd_settings
+    redirect_to_repository
   end
 
   def edit
@@ -38,7 +39,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
   def update
     if deploy_key.update(update_params)
       flash[:notice] = _('Deploy key was successfully updated.')
-      redirect_to_ci_cd_settings
+      redirect_to_repository
     else
       render 'edit'
     end
@@ -50,7 +51,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
     return render_404 unless key
 
     respond_to do |format|
-      format.html { redirect_to_ci_cd_settings }
+      format.html { redirect_to_repository }
       format.json { head :ok }
     end
   end
@@ -61,7 +62,7 @@ class Projects::DeployKeysController < Projects::ApplicationController
     return render_404 unless deploy_key_project
 
     respond_to do |format|
-      format.html { redirect_to_ci_cd_settings }
+      format.html { redirect_to_repository }
       format.json { head :ok }
     end
   end
@@ -97,7 +98,9 @@ class Projects::DeployKeysController < Projects::ApplicationController
     end
   end
 
-  def redirect_to_ci_cd_settings
-    redirect_to project_settings_ci_cd_path(@project, anchor: 'js-deploy-keys-settings')
+  private
+
+  def redirect_to_repository
+    redirect_to_repository_settings(@project, anchor: 'js-deploy-keys-settings')
   end
 end

app/controllers/projects/settings/ci_cd_controller.rb

@@ -88,7 +88,6 @@ module Projects
         define_triggers_variables
         define_badges_variables
         define_auto_devops_variables
-        define_deploy_keys
       end
 
       def define_runners_variables
@@ -135,10 +134,6 @@ module Projects
       def define_auto_devops_variables
         @auto_devops = @project.auto_devops || ProjectAutoDevops.new
       end
-
-      def define_deploy_keys
-        @deploy_keys = DeployKeysPresenter.new(@project, current_user: current_user)
-      end
     end
   end
 end

app/controllers/projects/settings/repository_controller.rb

@@ -63,6 +63,8 @@ module Projects
       end
 
       def define_variables
+        @deploy_keys = DeployKeysPresenter.new(@project, current_user: current_user)
+
         define_deploy_token_variables
         define_protected_refs
         remote_mirror

app/views/projects/settings/ci_cd/show.html.haml

@@ -51,8 +51,6 @@
   .settings-content
     = render 'ci/variables/index', save_endpoint: project_variables_path(@project)
 
-= render @deploy_keys
-
 %section.settings.no-animate#js-pipeline-triggers{ class: ('expanded' if expanded) }
   .settings-header
     %h4

app/views/projects/settings/repository/show.html.haml

@@ -13,6 +13,7 @@
 -# reused in EE.
 = render "projects/settings/repository/protected_branches"
 = render "shared/deploy_tokens/index", group_or_project: @project, description: deploy_token_description
+= render @deploy_keys
 = render "projects/cleanup/show"
 
 = render_if_exists 'shared/promotions/promote_repository_features'

doc/ci/pipelines/settings.md

@@ -288,14 +288,6 @@ https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?st
 
 [Environment variables](../variables/README.md#gitlab-cicd-environment-variables) can be set in an environment to be available to a runner.
 
-## Deploy Keys
-
-With Deploy Keys, GitLab allows you to import SSH public keys. You can then have
-read only or read/write access to your project from the machines the keys were generated from.
-
-SSH keys added to your project settings will be used for continuous integration,
-staging, or production servers.
-
 <!-- ## Troubleshooting
 
 Include any troubleshooting steps that you can foresee. If you know beforehand what issues

doc/ssh/README.md

@@ -384,9 +384,7 @@ If you don't have a key pair, you might want to use a
 
 Project maintainers and owners can add a deploy key for a repository.
 
-1. Navigate to the project's **Settings** page, then:
-   - On GitLab 12.8 and earlier, click **Repository**.
-   - On GitLab 12.9 and later, click **CI / CD**.
+1. Navigate to the project's **Settings > Repository** page.
 1. Expand the **Deploy Keys** section.
 1. Specify a title for the new deploy key and paste a public SSH key.
 
@@ -432,9 +430,7 @@ your repository".
 Once a GitLab administrator adds the Global Deployment key, project maintainers
 and owners can add it by:
 
-1. Navigating the settings page:
-   - On GitLab 12.8 and earlier, the project's **Settings > Repository** page.
-   - On GitLab 12.9 and later, the project's **Settings > CI / CD** page.
+1. Navigate to the project's **Settings > Repository** page.
 1. Expanding the **Deploy Keys** section.
 1. Clicking **Enable** next to the appropriate key listed under
    **Public deploy keys available to any project**.

ee/changelogs/unreleased/212775-revert-deploy-keys-move.yml

+---
+title: Move deploy keys section back to repository settings
+merge_request: 29184
+author:
+type: changed

ee/spec/controllers/projects/deploy_keys_controller_spec.rb

@@ -30,7 +30,7 @@ describe Projects::DeployKeysController do
     it 'records an audit event' do
       expect { post :create, params: params }.to change { AuditEvent.count }.by(1)
 
-      expect(response).to redirect_to(project_settings_ci_cd_path(project, anchor: 'js-deploy-keys-settings'))
+      expect(response).to redirect_to(project_settings_repository_path(project, anchor: 'js-deploy-keys-settings'))
     end
   end
 

qa/qa/page/project/settings/ci_cd.rb

@@ -13,16 +13,6 @@ module QA
             element :variables_settings_content
           end
 
-          view 'app/views/projects/deploy_keys/_index.html.haml' do
-            element :deploy_keys_settings
-          end
-
-          def expand_deploy_keys(&block)
-            expand_section(:deploy_keys_settings) do
-              Settings::DeployKeys.perform(&block)
-            end
-          end
-
           def expand_runners_settings(&block)
             expand_section(:runners_settings_content) do
               Settings::Runners.perform(&block)

qa/qa/page/project/settings/repository.rb

@@ -19,12 +19,22 @@ module QA
             element :deploy_tokens_settings
           end
 
+          view 'app/views/projects/deploy_keys/_index.html.haml' do
+            element :deploy_keys_settings
+          end
+
           def expand_deploy_tokens(&block)
             expand_section(:deploy_tokens_settings) do
               Settings::DeployTokens.perform(&block)
             end
           end
 
+          def expand_deploy_keys(&block)
+            expand_section(:deploy_keys_settings) do
+              Settings::DeployKeys.perform(&block)
+            end
+          end
+
           def expand_protected_branches(&block)
             expand_section(:protected_branches_settings) do
               ProtectedBranches.perform(&block)

qa/qa/resource/deploy_key.rb

@@ -6,7 +6,7 @@ module QA
       attr_accessor :title, :key
 
       attribute :md5_fingerprint do
-        Page::Project::Settings::CICD.perform do |setting|
+        Page::Project::Settings::Repository.perform do |setting|
           setting.expand_deploy_keys do |key|
             key.find_md5_fingerprint(title)
           end
@@ -23,9 +23,9 @@ module QA
       def fabricate!
         project.visit!
 
-        Page::Project::Menu.perform(&:go_to_ci_cd_settings)
+        Page::Project::Menu.perform(&:go_to_repository_settings)
 
-        Page::Project::Settings::CICD.perform do |setting|
+        Page::Project::Settings::Repository.perform do |setting|
           setting.expand_deploy_keys do |page|
             page.fill_key_title(title)
             page.fill_key_value(key)

qa/qa/specs/features/browser_ui/6_release/deploy_key/add_deploy_key_spec.rb

@@ -17,7 +17,7 @@ module QA
 
         expect(deploy_key.md5_fingerprint).to eq key.md5_fingerprint
 
-        Page::Project::Settings::CICD.perform do |setting|
+        Page::Project::Settings::Repository.perform do |setting|
           setting.expand_deploy_keys do |keys|
             expect(keys).to have_key(deploy_key_title, key.md5_fingerprint)
           end

spec/controllers/projects/deploy_keys_controller_spec.rb

@@ -19,10 +19,10 @@ describe Projects::DeployKeysController do
     end
 
     context 'when html requested' do
-      it 'redirects to project ci / cd settings with the correct anchor' do
+      it 'redirects to project settings with the correct anchor' do
         get :index, params: params
 
-        expect(response).to redirect_to(project_settings_ci_cd_path(project, anchor: 'js-deploy-keys-settings'))
+        expect(response).to redirect_to(project_settings_repository_path(project, anchor: 'js-deploy-keys-settings'))
       end
     end
 
@@ -87,13 +87,13 @@ describe Projects::DeployKeysController do
     it 'creates a new deploy key for the project' do
       expect { post :create, params: create_params }.to change(project.deploy_keys, :count).by(1)
 
-      expect(response).to redirect_to(project_settings_ci_cd_path(project, anchor: 'js-deploy-keys-settings'))
+      expect(response).to redirect_to(project_settings_repository_path(project, anchor: 'js-deploy-keys-settings'))
     end
 
     it 'redirects to project settings with the correct anchor' do
       post :create, params: create_params
 
-      expect(response).to redirect_to(project_settings_ci_cd_path(project, anchor: 'js-deploy-keys-settings'))
+      expect(response).to redirect_to(project_settings_repository_path(project, anchor: 'js-deploy-keys-settings'))
     end
 
     context 'when the deploy key is invalid' do
@@ -153,7 +153,7 @@ describe Projects::DeployKeysController do
 
         expect(DeployKeysProject.where(project_id: project.id, deploy_key_id: deploy_key.id).count).to eq(1)
         expect(response).to have_gitlab_http_status(:found)
-        expect(response).to redirect_to(namespace_project_settings_ci_cd_path(anchor: 'js-deploy-keys-settings'))
+        expect(response).to redirect_to(namespace_project_settings_repository_path(anchor: 'js-deploy-keys-settings'))
       end
 
       it 'returns 404' do
@@ -175,7 +175,7 @@ describe Projects::DeployKeysController do
 
         expect(DeployKeysProject.where(project_id: project.id, deploy_key_id: deploy_key.id).count).to eq(1)
         expect(response).to have_gitlab_http_status(:found)
-        expect(response).to redirect_to(namespace_project_settings_ci_cd_path(anchor: 'js-deploy-keys-settings'))
+        expect(response).to redirect_to(namespace_project_settings_repository_path(anchor: 'js-deploy-keys-settings'))
       end
     end
   end
@@ -216,7 +216,7 @@ describe Projects::DeployKeysController do
         put :disable, params: { id: deploy_key.id, namespace_id: project.namespace, project_id: project }
 
         expect(response).to have_gitlab_http_status(:found)
-        expect(response).to redirect_to(namespace_project_settings_ci_cd_path(anchor: 'js-deploy-keys-settings'))
+        expect(response).to redirect_to(namespace_project_settings_repository_path(anchor: 'js-deploy-keys-settings'))
 
         expect { DeployKey.find(deploy_key.id) }.to raise_error(ActiveRecord::RecordNotFound)
       end
@@ -239,7 +239,7 @@ describe Projects::DeployKeysController do
         end.to change { DeployKey.count }.by(-1)
 
         expect(response).to have_gitlab_http_status(:found)
-        expect(response).to redirect_to(namespace_project_settings_ci_cd_path(anchor: 'js-deploy-keys-settings'))
+        expect(response).to redirect_to(namespace_project_settings_repository_path(anchor: 'js-deploy-keys-settings'))
 
         expect { DeployKey.find(deploy_key.id) }.to raise_error(ActiveRecord::RecordNotFound)
       end

spec/features/projects/deploy_keys_spec.rb

@@ -17,7 +17,7 @@ describe 'Project deploy keys', :js do
     end
 
     it 'removes association between project and deploy key' do
-      visit project_settings_ci_cd_path(project)
+      visit project_settings_repository_path(project)
 
       page.within(find('.qa-deploy-keys-settings')) do
         expect(page).to have_selector('.deploy-key', count: 1)

spec/features/projects/settings/ci_cd_settings_spec.rb

-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'Projects > Settings > CI / CD settings' do
-  let_it_be(:project) { create(:project_empty_repo) }
-  let_it_be(:user) { create(:user) }
-  let_it_be(:role) { :maintainer }
-
-  context 'Deploy Keys', :js do
-    let_it_be(:private_deploy_key) { create(:deploy_key, title: 'private_deploy_key', public: false) }
-    let_it_be(:public_deploy_key) { create(:another_deploy_key, title: 'public_deploy_key', public: true) }
-    let(:new_ssh_key) { attributes_for(:key)[:key] }
-
-    before do
-      project.add_role(user, role)
-      sign_in(user)
-    end
-
-    it 'get list of keys' do
-      project.deploy_keys << private_deploy_key
-      project.deploy_keys << public_deploy_key
-
-      visit project_settings_ci_cd_path(project)
-
-      expect(page).to have_content('private_deploy_key')
-      expect(page).to have_content('public_deploy_key')
-    end
-
-    it 'add a new deploy key' do
-      visit project_settings_ci_cd_path(project)
-
-      fill_in 'deploy_key_title', with: 'new_deploy_key'
-      fill_in 'deploy_key_key', with: new_ssh_key
-      check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
-      click_button 'Add key'
-
-      expect(page).to have_content('new_deploy_key')
-      expect(page).to have_content('Write access allowed')
-    end
-
-    it 'edit an existing deploy key' do
-      project.deploy_keys << private_deploy_key
-      visit project_settings_ci_cd_path(project)
-
-      find('.deploy-key', text: private_deploy_key.title).find('.ic-pencil').click
-
-      fill_in 'deploy_key_title', with: 'updated_deploy_key'
-      check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
-      click_button 'Save changes'
-
-      expect(page).to have_content('updated_deploy_key')
-      expect(page).to have_content('Write access allowed')
-    end
-
-    it 'edit an existing public deploy key to be writable' do
-      project.deploy_keys << public_deploy_key
-      visit project_settings_ci_cd_path(project)
-
-      find('.deploy-key', text: public_deploy_key.title).find('.ic-pencil').click
-
-      check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
-      click_button 'Save changes'
-
-      expect(page).to have_content('public_deploy_key')
-      expect(page).to have_content('Write access allowed')
-    end
-
-    it 'edit a deploy key from projects user has access to' do
-      project2 = create(:project_empty_repo)
-      project2.add_role(user, role)
-      project2.deploy_keys << private_deploy_key
-
-      visit project_settings_ci_cd_path(project)
-
-      find('.js-deployKeys-tab-available_project_keys').click
-
-      find('.deploy-key', text: private_deploy_key.title).find('.ic-pencil').click
-
-      fill_in 'deploy_key_title', with: 'updated_deploy_key'
-      click_button 'Save changes'
-
-      find('.js-deployKeys-tab-available_project_keys').click
-
-      expect(page).to have_content('updated_deploy_key')
-    end
-
-    it 'remove an existing deploy key' do
-      project.deploy_keys << private_deploy_key
-      visit project_settings_ci_cd_path(project)
-
-      accept_confirm { find('.deploy-key', text: private_deploy_key.title).find('.ic-remove').click }
-
-      expect(page).not_to have_content(private_deploy_key.title)
-    end
-  end
-end

spec/features/projects/settings/repository_settings_spec.rb

@@ -39,6 +39,89 @@ describe 'Projects > Settings > Repository settings' do
       end
     end
 
+    context 'Deploy Keys', :js do
+      let_it_be(:private_deploy_key) { create(:deploy_key, title: 'private_deploy_key', public: false) }
+      let_it_be(:public_deploy_key) { create(:another_deploy_key, title: 'public_deploy_key', public: true) }
+      let(:new_ssh_key) { attributes_for(:key)[:key] }
+
+      it 'get list of keys' do
+        project.deploy_keys << private_deploy_key
+        project.deploy_keys << public_deploy_key
+
+        visit project_settings_repository_path(project)
+
+        expect(page).to have_content('private_deploy_key')
+        expect(page).to have_content('public_deploy_key')
+      end
+
+      it 'add a new deploy key' do
+        visit project_settings_repository_path(project)
+
+        fill_in 'deploy_key_title', with: 'new_deploy_key'
+        fill_in 'deploy_key_key', with: new_ssh_key
+        check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
+        click_button 'Add key'
+
+        expect(page).to have_content('new_deploy_key')
+        expect(page).to have_content('Write access allowed')
+      end
+
+      it 'edit an existing deploy key' do
+        project.deploy_keys << private_deploy_key
+        visit project_settings_repository_path(project)
+
+        find('.deploy-key', text: private_deploy_key.title).find('.ic-pencil').click
+
+        fill_in 'deploy_key_title', with: 'updated_deploy_key'
+        check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
+        click_button 'Save changes'
+
+        expect(page).to have_content('updated_deploy_key')
+        expect(page).to have_content('Write access allowed')
+      end
+
+      it 'edit an existing public deploy key to be writable' do
+        project.deploy_keys << public_deploy_key
+        visit project_settings_repository_path(project)
+
+        find('.deploy-key', text: public_deploy_key.title).find('.ic-pencil').click
+
+        check 'deploy_key_deploy_keys_projects_attributes_0_can_push'
+        click_button 'Save changes'
+
+        expect(page).to have_content('public_deploy_key')
+        expect(page).to have_content('Write access allowed')
+      end
+
+      it 'edit a deploy key from projects user has access to' do
+        project2 = create(:project_empty_repo)
+        project2.add_role(user, role)
+        project2.deploy_keys << private_deploy_key
+
+        visit project_settings_repository_path(project)
+
+        find('.js-deployKeys-tab-available_project_keys').click
+
+        find('.deploy-key', text: private_deploy_key.title).find('.ic-pencil').click
+
+        fill_in 'deploy_key_title', with: 'updated_deploy_key'
+        click_button 'Save changes'
+
+        find('.js-deployKeys-tab-available_project_keys').click
+
+        expect(page).to have_content('updated_deploy_key')
+      end
+
+      it 'remove an existing deploy key' do
+        project.deploy_keys << private_deploy_key
+        visit project_settings_repository_path(project)
+
+        accept_confirm { find('.deploy-key', text: private_deploy_key.title).find('.ic-remove').click }
+
+        expect(page).not_to have_content(private_deploy_key.title)
+      end
+    end
+
     context 'remote mirror settings' do
       before do
         visit project_settings_repository_path(project)

spec/features/projects/settings/user_interacts_with_deploy_keys_spec.rb

@@ -20,7 +20,7 @@ describe "User interacts with deploy keys", :js do
         click_button("Enable")
 
         expect(page).not_to have_selector(".fa-spinner")
-        expect(current_path).to eq(project_settings_ci_cd_path(project))
+        expect(current_path).to eq(project_settings_repository_path(project))
 
         find(".js-deployKeys-tab-enabled_keys").click
 
@@ -96,7 +96,7 @@ describe "User interacts with deploy keys", :js do
 
       click_button("Add key")
 
-      expect(current_path).to eq(project_settings_ci_cd_path(project))
+      expect(current_path).to eq(project_settings_repository_path(project))
 
       page.within(".deploy-keys") do
         expect(page).to have_content(DEPLOY_KEY_TITLE)