Add Packages & Registries menu to project sidebar refactor

This commits move the Packages & Registries menu
from the HAML view to the new refactor.

app/views/layouts/nav/sidebar/_project_menus.html.haml

-= render_if_exists 'layouts/nav/sidebar/project_packages_link'
-
 - if project_nav_tab? :analytics
   = render 'layouts/nav/sidebar/analytics_links', links: project_analytics_navbar_links(@project, current_user)
 

app/views/layouts/nav/sidebar/_project_packages_link.html.haml

-- packages_link = project_nav_tab?(:packages) ? project_packages_path(@project) : project_container_registry_index_path(@project)
-
-- if project_nav_tab?(:packages) || project_nav_tab?(:container_registry)
-  = nav_link controller: [:packages, :repositories, :infrastructure_registry] do
-    = link_to packages_link, data: { qa_selector: 'packages_link' } do
-      .nav-icon-container
-        = sprite_icon('package')
-      %span.nav-item-name
-        = _('Packages & Registries')
-    %ul.sidebar-sub-level-items
-      = nav_link(controller: [:packages, :repositories, :infrastructure_registry], html_options: { class: "fly-out-top-item" } ) do
-        = link_to packages_link do
-          %strong.fly-out-top-item-name
-            = _('Packages & Registries')
-      %li.divider.fly-out-top-item
-      - if project_nav_tab? :packages
-        = nav_link controller: :packages do
-          = link_to project_packages_path(@project), title: _('Package Registry') do
-            %span= _('Package Registry')
-      - if project_nav_tab? :container_registry
-        = nav_link controller: :repositories do
-          = link_to project_container_registry_index_path(@project), class: 'shortcuts-container-registry', title: _('Container Registry') do
-            %span= _('Container Registry')
-      - if project_nav_tab? :infrastructure_registry
-        = nav_link controller: :infrastructure_registry do
-          = link_to project_infrastructure_registry_index_path(@project), title: _('Infrastructure Registry') do
-            %span= _('Infrastructure Registry')

lib/sidebars/projects/menus/packages_registries_menu.rb

+# frozen_string_literal: true
+
+module Sidebars
+  module Projects
+    module Menus
+      class PackagesRegistriesMenu < ::Sidebars::Menu
+        override :configure_menu_items
+        def configure_menu_items
+          add_item(packages_registry_menu_item)
+          add_item(container_registry_menu_item)
+          add_item(infrastructure_registry_menu_item)
+
+          true
+        end
+
+        override :link
+        def link
+          items.first.link
+        end
+
+        override :title
+        def title
+          _('Packages & Registries')
+        end
+
+        override :sprite_icon
+        def sprite_icon
+          'package'
+        end
+
+        private
+
+        def packages_registry_menu_item
+          return unless ::Gitlab.config.packages.enabled
+          return unless can?(context.current_user, :read_package, context.project)
+
+          ::Sidebars::MenuItem.new(
+            title: _('Package Registry'),
+            link: project_packages_path(context.project),
+            active_routes: { controller: :packages },
+            item_id: :packages_registry,
+            container_html_options: { class: 'shortcuts-container-registry' }
+          )
+        end
+
+        def container_registry_menu_item
+          return unless ::Gitlab.config.registry.enabled
+          return unless can?(context.current_user, :read_container_image, context.project)
+
+          ::Sidebars::MenuItem.new(
+            title: _('Container Registry'),
+            link: project_container_registry_index_path(context.project),
+            active_routes: { controller: :repositories },
+            item_id: :container_registry
+          )
+        end
+
+        def infrastructure_registry_menu_item
+          return if Feature.disabled?(:infrastructure_registry_page, context.current_user)
+
+          ::Sidebars::MenuItem.new(
+            title: _('Infrastructure Registry'),
+            link: project_infrastructure_registry_index_path(context.project),
+            active_routes: { controller: :infrastructure_registry },
+            item_id: :infrastructure_registry
+          )
+        end
+      end
+    end
+  end
+end

lib/sidebars/projects/panel.rb

@@ -17,6 +17,7 @@ module Sidebars
         add_menu(Sidebars::Projects::Menus::CiCdMenu.new(context))
         add_menu(Sidebars::Projects::Menus::SecurityComplianceMenu.new(context))
         add_menu(Sidebars::Projects::Menus::OperationsMenu.new(context))
+        add_menu(Sidebars::Projects::Menus::PackagesRegistriesMenu.new(context))
       end
 
       override :render_raw_menus_partial

qa/qa/page/project/sub_menus/packages.rb

@@ -7,19 +7,11 @@ module QA
         module Packages
           extend QA::Page::PageConcern
 
-          def self.included(base)
-            super
-
-            base.class_eval do
-              view 'app/views/layouts/nav/sidebar/_project_packages_link.html.haml' do
-                element :packages_link
-              end
-            end
-          end
-
           def click_packages_link
-            within_sidebar do
-              click_element :packages_link
+            hover_registry do
+              within_submenu do
+                click_element(:sidebar_menu_item_link, menu_item: 'Package Registry')
+              end
             end
           end
 
@@ -35,8 +27,8 @@ module QA
 
           def hover_registry
             within_sidebar do
-              scroll_to_element(:packages_link)
-              find_element(:packages_link).hover
+              scroll_to_element(:sidebar_menu_link, menu_item: 'Packages & Registries')
+              find_element(:sidebar_menu_link, menu_item: 'Packages & Registries').hover
 
               yield
             end

spec/features/projects/settings/packages_settings_spec.rb

@@ -3,36 +3,32 @@
 require 'spec_helper'
 
 RSpec.describe 'Projects > Settings > Packages', :js do
-  let(:project) { create(:project) }
-  let(:user) { create(:user) }
+  let_it_be(:project) { create(:project) }
+
+  let(:user) { project.owner }
 
   before do
     sign_in(user)
-    project.add_maintainer(user)
+
+    stub_config(packages: { enabled: packages_enabled })
+
+    visit edit_project_path(project)
   end
 
   context 'Packages enabled in config' do
-    before do
-      allow(Gitlab.config.packages).to receive(:enabled).and_return(true)
-    end
+    let(:packages_enabled) { true }
 
     it 'displays the packages toggle button' do
-      visit edit_project_path(project)
-
-      expect(page).to have_content('Packages')
+      expect(page).to have_button('Packages', class: 'gl-toggle')
       expect(page).to have_selector('input[name="project[packages_enabled]"] + button', visible: true)
     end
   end
 
   context 'Packages disabled in config' do
-    before do
-      allow(Gitlab.config.packages).to receive(:enabled).and_return(false)
-    end
+    let(:packages_enabled) { false }
 
     it 'does not show up in UI' do
-      visit edit_project_path(project)
-
-      expect(page).not_to have_content('Packages')
+      expect(page).not_to have_button('Packages', class: 'gl-toggle')
     end
   end
 end

spec/lib/sidebars/projects/menus/packages_registries_menu_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Sidebars::Projects::Menus::PackagesRegistriesMenu do
+  let(:project) { build(:project) }
+  let(:user) { project.owner }
+  let(:context) { Sidebars::Projects::Context.new(current_user: user, container: project) }
+
+  subject { described_class.new(context) }
+
+  describe '#render?' do
+    context 'when menu does not have any menu item to show' do
+      it 'returns false' do
+        allow(subject).to receive(:has_items?).and_return(false)
+
+        expect(subject.render?).to eq false
+      end
+    end
+
+    context 'when menu has menu items to show' do
+      it 'returns true' do
+        expect(subject.render?).to eq true
+      end
+    end
+  end
+
+  describe '#link' do
+    let(:registry_enabled) { true }
+    let(:packages_enabled) { true }
+
+    before do
+      stub_container_registry_config(enabled: registry_enabled)
+      stub_config(packages: { enabled: packages_enabled })
+    end
+
+    context 'when Packages Registry is visible' do
+      it 'menu link points to Packages Registry page' do
+        expect(subject.link).to eq described_class.new(context).items.find { |i| i.item_id == :packages_registry }.link
+      end
+    end
+
+    context 'when Packages Registry is not visible' do
+      let(:packages_enabled) { false }
+
+      it 'menu link points to Container Registry page' do
+        expect(subject.link).to eq described_class.new(context).items.find { |i| i.item_id == :container_registry }.link
+      end
+
+      context 'when Container Registry is not visible' do
+        let(:registry_enabled) { false }
+
+        it 'menu link points to Infrastructure Registry page' do
+          expect(subject.link).to eq described_class.new(context).items.find { |i| i.item_id == :infrastructure_registry }.link
+        end
+      end
+    end
+  end
+
+  describe 'Packages Registry' do
+    subject { described_class.new(context).items.find { |i| i.item_id == :packages_registry }}
+
+    context 'when user can read packages' do
+      context 'when config package setting is disabled' do
+        it 'the menu item is not added to list of menu items' do
+          stub_config(packages: { enabled: false })
+
+          is_expected.to be_nil
+        end
+      end
+
+      context 'when config package setting is enabled' do
+        it 'the menu item is added to list of menu items' do
+          stub_config(packages: { enabled: true })
+
+          is_expected.not_to be_nil
+        end
+      end
+    end
+
+    context 'when user cannot read packages' do
+      let(:user) { nil }
+
+      it 'the menu item is not added to list of menu items' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  describe 'Container Registry' do
+    subject { described_class.new(context).items.find { |i| i.item_id == :container_registry }}
+
+    context 'when user can read container images' do
+      context 'when config registry setting is disabled' do
+        it 'the menu item is not added to list of menu items' do
+          stub_container_registry_config(enabled: false)
+
+          is_expected.to be_nil
+        end
+      end
+
+      context 'when config registry setting is enabled' do
+        it 'the menu item is added to list of menu items' do
+          stub_container_registry_config(enabled: true)
+
+          is_expected.not_to be_nil
+        end
+      end
+    end
+
+    context 'when user cannot read container images' do
+      let(:user) { nil }
+
+      it 'the menu item is not added to list of menu items' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  describe 'Infrastructure Registry' do
+    subject { described_class.new(context).items.find { |i| i.item_id == :infrastructure_registry }}
+
+    context 'when feature flag :infrastructure_registry_page is enabled' do
+      it 'the menu item is added to list of menu items' do
+        stub_feature_flags(infrastructure_registry_page: true)
+
+        is_expected.not_to be_nil
+      end
+    end
+
+    context 'when feature flag :infrastructure_registry_page is disabled' do
+      it 'the menu item is not added to list of menu items' do
+        stub_feature_flags(infrastructure_registry_page: false)
+
+        is_expected.to be_nil
+      end
+    end
+  end
+end

spec/views/layouts/nav/sidebar/_project.html.haml_spec.rb

@@ -580,78 +580,72 @@ RSpec.describe 'layouts/nav/sidebar/_project' do
     end
   end
 
-  describe 'packages tab' do
-    before do
-      stub_container_registry_config(enabled: true)
+  describe 'Packages and Registries' do
+    let(:registry_enabled) { true }
+    let(:packages_enabled) { true }
 
-      allow(controller).to receive(:controller_name)
-        .and_return('repositories')
-      allow(controller).to receive(:controller_path)
-        .and_return('projects/registry/repositories')
+    before do
+      stub_container_registry_config(enabled: registry_enabled)
+      stub_config(packages: { enabled: packages_enabled })
     end
 
-    it 'highlights sidebar item and flyout' do
+    it 'top level navigation link is visible and points to package registry page' do
       render
 
-      expect(rendered).to have_css('.sidebar-top-level-items > li.active', count: 1)
-      expect(rendered).to have_css('.sidebar-sub-level-items > li.fly-out-top-item.active', count: 1)
+      expect(rendered).to have_link('Packages & Registries', href: project_packages_path(project))
     end
 
-    it 'highlights container registry tab' do
-      render
+    describe 'Packages Registry' do
+      it 'shows link to package registry page' do
+        render
 
-      expect(rendered).to have_css('.sidebar-sub-level-items > li:not(.fly-out-top-item).active', text: 'Container Registry')
-    end
-  end
+        expect(rendered).to have_link('Package Registry', href: project_packages_path(project))
+      end
 
-  describe 'Packages' do
-    let_it_be(:user) { create(:user) }
+      context 'when packages config setting is not enabled' do
+        let(:packages_enabled) { false }
 
-    let_it_be(:package_menu_name) { 'Packages & Registries' }
-    let_it_be(:package_entry_name) { 'Package Registry' }
+        it 'does not show link to package registry page' do
+          render
 
-    before do
-      project.team.add_developer(user)
-      sign_in(user)
-      stub_container_registry_config(enabled: true)
+          expect(rendered).not_to have_link('Package Registry', href: project_packages_path(project))
+        end
+      end
     end
 
-    context 'when packages is enabled' do
-      it 'packages link is visible' do
+    describe 'Container Registry' do
+      it 'shows link to container registry page' do
         render
 
-        expect(rendered).to have_link(package_menu_name, href: project_packages_path(project))
+        expect(rendered).to have_link('Container Registry', href: project_container_registry_index_path(project))
       end
 
-      it 'packages list link is visible' do
-        render
-
-        expect(rendered).to have_link(package_entry_name, href: project_packages_path(project))
-      end
+      context 'when container config setting is not enabled' do
+        let(:registry_enabled) { false }
 
-      it 'container registry link is visible' do
-        render
+        it 'does not show link to package registry page' do
+          render
 
-        expect(rendered).to have_link('Container Registry', href: project_container_registry_index_path(project))
+          expect(rendered).not_to have_link('Container Registry', href: project_container_registry_index_path(project))
+        end
       end
     end
 
-    context 'when container registry is disabled' do
-      before do
-        stub_container_registry_config(enabled: false)
-      end
-
-      it 'packages top level and list link are visible' do
+    describe 'Infrastructure Registry' do
+      it 'shows link to infrastructure registry page' do
         render
 
-        expect(rendered).to have_link(package_menu_name, href: project_packages_path(project))
-        expect(rendered).to have_link(package_entry_name, href: project_packages_path(project))
+        expect(rendered).to have_link('Infrastructure Registry', href: project_infrastructure_registry_index_path(project))
       end
 
-      it 'container registry link is not visible' do
-        render
+      context 'when feature flag :infrastructure_registry_page is disabled' do
+        it 'does not show link to package registry page' do
+          stub_feature_flags(infrastructure_registry_page: false)
 
-        expect(rendered).not_to have_link('Container Registry', href: project_container_registry_index_path(project))
+          render
+
+          expect(rendered).not_to have_link('Infrastructure Registry', href: project_infrastructure_registry_index_path(project))
+        end
       end
     end
   end