Merge branch '276221-assign-compliance-label-to-projectg' into 'master'

Assign custom Compliance Framework Labels to projects

See merge request gitlab-org/gitlab!50441

doc/user/project/settings/index.md

@@ -40,6 +40,26 @@ You can select a framework label to identify that your project has certain compl
 NOTE:
 Compliance framework labels do not affect your project settings.
 
+#### Custom compliance frameworks
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/276221) in GitLab 13.9.
+> - It's [deployed behind a feature flag](../../feature_flags.md), disabled by default.
+> - It's disabled on GitLab.com.
+> - It's not recommended for production use.
+> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-custom-compliance-frameworks). **(PREMIUM ONLY)**
+
+WARNING:
+This feature might not be available to you. Check the **version history** note above for details.
+
+GitLab 13.8 introduces custom compliance frameworks at the group-level. A group owner can create a compliance framework label
+and assign it to any number of projects within that group or sub-groups. When this feature is enabled, projects can only
+be assigned compliance framework labels that already exist within that group. 
+
+If existing [Compliance frameworks](#compliance-framework) are not sufficient, you can now create
+your own.
+
+New compliance framework labels can be created and updated using GraphQL. 
+
 ### Sharing and permissions
 
 For your repository, you can set up features such as public access, repository features,
@@ -299,3 +319,22 @@ Add the URL of a Jaeger server to allow your users to [easily access the Jaeger
 
 [Add Storage credentials](../../../operations/incident_management/status_page.md#sync-incidents-to-the-status-page)
 to enable the syncing of public Issues to a [deployed status page](../../../operations/incident_management/status_page.md#create-a-status-page-project).
+
+### Enable or disable custom compliance frameworks **(PREMIUM ONLY)**
+
+Enabling or disabling custom compliance frameworks is under development and not ready for production use. It is
+deployed behind a feature flag that is **disabled by default**.
+[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
+can enable it.
+
+To enable it:
+
+```ruby
+Feature.enable(:ff_custom_compliance_frameworks)
+```
+
+To disable it:
+
+```ruby
+Feature.disable(:ff_custom_compliance_frameworks)
+```

ee/app/services/ee/projects/update_service.rb

@@ -71,6 +71,8 @@ module EE
           framework_identifier = settings.delete(:framework)
           if framework_identifier.blank?
             settings.merge!(_destroy: true)
+          elsif ::Feature.enabled?(:ff_custom_compliance_frameworks)
+            settings[:compliance_management_framework] = project.namespace.root_ancestor.compliance_management_frameworks.find(framework_identifier)
           else
             settings[:compliance_management_framework] = ComplianceManagement::Framework.find_or_create_legacy_default_framework(project, framework_identifier)
           end

ee/app/views/compliance_management/compliance_framework/_project_settings.html.haml

 - return unless current_user.can?(:admin_compliance_framework, @project)
 
 .row
-  .form-group.col-md-9.mb-5
+  .form-group.col-md-9.gl-mb-6
+    - if Feature.enabled?(:ff_custom_compliance_frameworks)
+      - frameworks = @project.namespace.root_ancestor.compliance_management_frameworks
       = f.fields_for :compliance_framework_setting, ComplianceManagement::ComplianceFramework::ProjectSettings.new do |cf|
-      = cf.label :framework, _('Compliance framework (optional)'), class: 'label-bold'
+        = cf.label :framework, _('Compliance framework (optional)'), class: 'gl-font-weight-bold'
+        - if frameworks.any?
+          %p.text-secondary= _('Select required regulatory standard')
+          - selected_default_framework = @project.compliance_framework_setting&.compliance_management_framework&.id
+          = cf.select :framework, options_for_select(frameworks.map { |fw| [fw.name, fw.id] }, selected_default_framework), { selected: '', disabled: '', prompt: _('Choose your framework'), include_blank: _('None') }, class: 'form-control'
+        - else
+          %p.text-secondary
+            = _("No compliance frameworks are in use. Create one using the GraphQL API.")
+    - else
+      = f.fields_for :compliance_framework_setting, ComplianceManagement::ComplianceFramework::ProjectSettings.new do |cf|
+        = cf.label :framework, _('Compliance framework (optional)'), class: 'gl-font-weight-bold'
         %p.text-secondary= _('Select required regulatory standard')
         - selected_default_framework = @project.compliance_framework_setting&.compliance_management_framework&.default_framework_definition&.identifier
         = cf.select :framework, options_for_select(compliance_framework_options, selected_default_framework), { selected: '', disabled: '', prompt: _('Choose your framework'), include_blank: _('None') }, class: 'form-control'
+

ee/spec/controllers/projects_controller_spec.rb

@@ -524,15 +524,59 @@ RSpec.describe ProjectsController do
     end
 
     context 'compliance framework settings' do
-      let(:framework) { ComplianceManagement::Framework::DEFAULT_FRAMEWORKS.last }
-      let(:params) { { compliance_framework_setting_attributes: { framework: framework.identifier } } }
+      shared_examples 'no compliance framework is set' do
+        it 'does not change compliance framework for project' do
+          put :update,
+              params: {
+                namespace_id: project.namespace,
+                id: project,
+                project: params
+              }
+          project.reload
+
+          expect(project.compliance_framework_setting).to be_nil
+        end
+      end
 
       context 'when unlicensed' do
+        let(:framework) { create(:compliance_framework, namespace: project.namespace.root_ancestor) }
+        let(:params) { { compliance_framework_setting_attributes: { framework: framework.id } } }
+
         before do
           stub_licensed_features(compliance_framework: false)
         end
 
-        it 'ignores any compliance framework params' do
+        it_behaves_like 'no compliance framework is set'
+
+        context 'custom frameworks are disabled' do
+          let(:framework) { ComplianceManagement::Framework::DEFAULT_FRAMEWORKS.last }
+          let(:params) { { compliance_framework_setting_attributes: { framework: framework.identifier } } }
+
+          before do
+            stub_feature_flags(ff_custom_compliance_frameworks: false)
+          end
+
+          it_behaves_like 'no compliance framework is set'
+        end
+      end
+
+      context 'when licensed' do
+        let(:framework) { create(:compliance_framework, namespace: project.namespace.root_ancestor) }
+        let(:params) { { compliance_framework_setting_attributes: { framework: framework.id } } }
+
+        before do
+          stub_licensed_features(compliance_framework: true)
+        end
+
+        context 'current_user is a project maintainer' do
+          let_it_be(:maintainer) { create(:user) }
+
+          before do
+            project.add_maintainer(maintainer)
+            sign_in(maintainer)
+          end
+
+          it 'sets the compliance framework' do
             put :update,
                 params: {
                   namespace_id: project.namespace,
@@ -541,16 +585,18 @@ RSpec.describe ProjectsController do
                 }
             project.reload
 
-          expect(project.compliance_framework_setting).to be_nil
-        end
+            expect(project.compliance_framework_setting.compliance_management_framework).to eq(framework)
           end
 
-      context 'when licensed' do
+          context 'custom frameworks are disabled' do
+            let(:framework) { ComplianceManagement::Framework::DEFAULT_FRAMEWORKS.last }
+            let(:params) { { compliance_framework_setting_attributes: { framework: framework.identifier } } }
+
             before do
-          stub_licensed_features(compliance_framework: true)
+              stub_feature_flags(ff_custom_compliance_frameworks: false)
             end
 
-        it 'sets the compliance framework' do
+            it 'sets the compliance framework based on the framework identifier' do
               put :update,
                   params: {
                     namespace_id: project.namespace,
@@ -561,6 +607,22 @@ RSpec.describe ProjectsController do
 
               expect(project.compliance_framework_setting.compliance_management_framework.name).to eq(framework.name)
             end
+
+            it 'raises an error when using framework IDs for custom frameworks' do
+              framework = create(:compliance_framework, namespace: project.namespace.root_ancestor)
+              params = { compliance_framework_setting_attributes: { framework: framework.id } }
+
+              expect do
+                put :update,
+                    params: {
+                      namespace_id: project.namespace,
+                      id: project,
+                      project: params
+                    }
+              end.to raise_error(KeyError)
+            end
+          end
+        end
       end
     end
   end

ee/spec/services/projects/update_service_spec.rb

@@ -258,11 +258,12 @@ RSpec.describe Projects::UpdateService, '#execute' do
     end
   end
 
-  context 'when compliance frameworks is set' do
+  context 'when custom compliance frameworks are disabled' do
     let(:project_setting) { create(:compliance_framework_project_setting, :gdpr) }
 
     before do
       stub_licensed_features(compliance_framework: true)
+      stub_feature_flags(ff_custom_compliance_frameworks: false)
       project.update!(compliance_framework_setting: project_setting)
     end
 
@@ -292,6 +293,49 @@ RSpec.describe Projects::UpdateService, '#execute' do
     end
   end
 
+  context 'when ff_custom_compliance_frameworks flag is enabled' do
+    let(:framework) { create(:compliance_framework, namespace: project.namespace) }
+    let(:opts) { { compliance_framework_setting_attributes: { framework: framework.id } } }
+
+    before do
+      stub_feature_flags(ff_custom_compliance_frameworks: true)
+    end
+
+    context 'when current_user has :admin_compliance_framework ability' do
+      before do
+        stub_licensed_features(compliance_framework: true)
+      end
+
+      it 'updates the framework' do
+        expect { update_project(project, user, opts) }.to change {
+          project
+            .reload
+            .compliance_management_frameworks
+        }.from([]).to([framework])
+      end
+
+      it 'unassigns a framework from a project' do
+        project.compliance_management_frameworks = [framework]
+
+        expect { update_project(project, user, { compliance_framework_setting_attributes: { framework: nil } }) }.to change {
+          project
+            .reload
+            .compliance_management_frameworks
+        }.from([framework]).to([])
+      end
+    end
+
+    context 'when current_user does not have :admin_compliance_framework ability' do
+      before do
+        stub_licensed_features(compliance_framework: false)
+      end
+
+      it 'does not set a framework' do
+        expect { update_project(project, user, opts) }.not_to change { project.reload.compliance_management_frameworks.count }
+      end
+    end
+  end
+
   context 'when compliance framework feature is disabled' do
     let(:framework) { ComplianceManagement::Framework::DEFAULT_FRAMEWORKS_BY_IDENTIFIER[:sox] }
     let(:opts) { { compliance_framework_setting_attributes: { framework: framework.identifier } } }

ee/spec/views/compliance_management/compliance_framework/_project_settings.html.haml_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'projects/edit.html.haml' do
+  let_it_be(:group) { create(:group) }
+  let_it_be(:group_owner) { create(:user) }
+  let_it_be(:project) { create(:project, namespace: group) }
+
+  before do
+    allow(view).to receive(:current_user).and_return(group_owner)
+    allow(group_owner).to receive(:can?).and_return(true)
+    assign(:project, project)
+    stub_licensed_features(custom_compliance_frameworks: true)
+  end
+
+  context 'feature enabled' do
+    before do
+      stub_feature_flags(ff_custom_compliance_frameworks: true)
+    end
+
+    context 'group has compliance frameworks' do
+      let_it_be(:framework) { create(:compliance_framework, namespace: group, name: 'Custom framework 23') }
+
+      it 'includes a dropdown including that framework' do
+        render
+
+        expect(rendered).to match /Custom framework 23/
+      end
+    end
+
+    context 'group has no compliance frameworks' do
+      before do
+        group.compliance_management_frameworks.delete_all
+      end
+
+      it 'shows a notification' do
+        render
+
+        expect(rendered).to match /No compliance frameworks are in use. Create one using the GraphQL API./
+      end
+    end
+  end
+
+  context 'feature disabled' do
+    before do
+      stub_feature_flags(ff_custom_compliance_frameworks: false)
+    end
+
+    it 'includes a dropdown including only the hard-coded frameworks' do
+      render
+
+      expect(rendered).to match /GDPR/
+      expect(rendered).to match /HIPAA/
+      expect(rendered).to match /PCI-DSS/
+      expect(rendered).to match /SOC 2/
+      expect(rendered).to match /SOX/
+    end
+  end
+end

locale/gitlab.pot

@@ -19318,6 +19318,9 @@ msgstr ""
 msgid "No commits present here"
 msgstr ""
 
+msgid "No compliance frameworks are in use. Create one using the GraphQL API."
+msgstr ""
+
 msgid "No connection could be made to a Gitaly Server, please check your logs!"
 msgstr ""