Merge branch '37894-handle-if-auto-devops-domain-is-not-set' into 'master'

Resolve "Handle if Auto DevOps domain is not set"

Closes #37894

See merge request gitlab-org/gitlab-ce!14319

app/helpers/auto_devops_helper.rb

@@ -5,6 +5,25 @@ module AutoDevopsHelper
       can?(current_user, :admin_pipeline, project) &&
       project.has_auto_devops_implicitly_disabled? &&
       !project.repository.gitlab_ci_yml &&
-      project.ci_services.active.none?
+      !project.ci_service
+  end
+
+  def auto_devops_warning_message(project)
+    missing_domain = !project.auto_devops&.has_domain?
+    missing_service = !project.kubernetes_service&.active?
+
+    if missing_service
+      params = {
+        kubernetes: link_to('Kubernetes service', edit_project_service_path(project, 'kubernetes'))
+      }
+
+      if missing_domain
+        _('Auto Review Apps and Auto Deploy need a domain name and the %{kubernetes} to work correctly.') % params
+      else
+        _('Auto Review Apps and Auto Deploy need the %{kubernetes} to work correctly.') % params
+      end
+    elsif missing_domain
+      _('Auto Review Apps and Auto Deploy need a domain name to work correctly.')
+    end
   end
 end

app/models/project_auto_devops.rb

@@ -6,6 +6,10 @@ class ProjectAutoDevops < ActiveRecord::Base
 
   validates :domain, allow_blank: true, hostname: { allow_numeric_hostname: true }
 
+  def has_domain?
+    domain.present?
+  end
+
   def variables
     variables = []
     variables << { key: 'AUTO_DEVOPS_DOMAIN', value: domain, public: true } if domain.present?

app/views/projects/pipelines_settings/_show.html.haml

@@ -3,11 +3,15 @@
     = form_for @project, url: project_pipelines_settings_path(@project) do |f|
       %fieldset.builds-feature
         .form-group
-          %p Pipelines need to have Auto DevOps enabled or have a .gitlab-ci.yml configured before you can begin using Continuous Integration and Delivery.
           %h5 Auto DevOps (Beta)
           %p
-            Auto DevOps will automatically build, test, and deploy your application based on a predefined Continious Integration and Delivery configuration.
+            Auto DevOps will automatically build, test, and deploy your application based on a predefined Continuous Integration and Delivery configuration.
+            This will happen starting with the next event (e.g.: push) that occurs to the project.
             = link_to 'Learn more about Auto DevOps', help_page_path('topics/autodevops/index.md')
+            - message = auto_devops_warning_message(@project)
+            - if message
+              %p.settings-message.text-center
+                = message.html_safe
           = f.fields_for :auto_devops_attributes, @auto_devops do |form|
             .radio
               = form.label :enabled_true do
@@ -15,26 +19,24 @@
                 %strong Enable Auto DevOps
                 %br
                 %span.descr
-                  The Auto DevOps pipeline configuration will be used when there is no .gitlab-ci.yml
-                  in the project.
+                  The Auto DevOps pipeline configuration will be used when there is no <code>.gitlab-ci.yml</code> in the project.
             .radio
               = form.label :enabled_false do
                 = form.radio_button :enabled, 'false'
                 %strong Disable Auto DevOps
                 %br
                 %span.descr
-                  A specific .gitlab-ci.yml file needs to be specified before you can begin using Continious Integration and Delivery.
+                  An explicit <code>.gitlab-ci.yml</code> needs to be specified before you can begin using Continious Integration and Delivery.
             .radio
               = form.label :enabled_nil do
                 = form.radio_button :enabled, ''
-                %strong
-                  Instance default (status: #{current_application_settings.auto_devops_enabled?})
+                %strong Instance default (#{current_application_settings.auto_devops_enabled? ? 'enabled' : 'disabled'})
                 %br
                 %span.descr
-                  Follow the instance default to either have Auto DevOps enabled or disabled when there is no project specific .gitlab-ci.yml file specified.
+                  Follow the instance default to either have Auto DevOps enabled or disabled when there is no project specific <code>.gitlab-ci.yml</code>.
                 %br
             %p
-              Define a domain used by Auto DevOps to deploy towards, this is required for deploys to succeed.
+              You need to specify a domain if you want to use Auto Review Apps and Auto Deploy stages.
             = form.text_field :domain, class: 'form-control', placeholder: 'domain.com'
 
         %hr

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

@@ -13,7 +13,7 @@
     %button.btn.js-settings-toggle
       = expanded ? 'Collapse' : 'Expand'
     %p
-      Update your CI/CD configuration, like job timeout.
+      Update your CI/CD configuration, like job timeout or Auto DevOps.
   .settings-content.no-animate{ class: ('expanded' if expanded) }
     = render 'projects/pipelines_settings/show'
 

changelogs/unreleased/37894-handle-if-auto-devops-domain-is-not-set.yml

+---
+title: Handle if Auto DevOps domain is not set in project settings
+merge_request:
+author:
+type: added

spec/models/project_auto_devops_spec.rb

@@ -8,7 +8,21 @@ describe ProjectAutoDevops do
   it { is_expected.to respond_to(:created_at) }
   it { is_expected.to respond_to(:updated_at) }
 
-  describe 'variables' do
+  describe '#has_domain?' do
+    context 'when domain is defined' do
+      let(:auto_devops) { build_stubbed(:project_auto_devops, project: project, domain: 'domain.com') }
+
+      it { expect(auto_devops).to have_domain }
+    end
+
+    context 'when domain is empty' do
+      let(:auto_devops) { build_stubbed(:project_auto_devops, project: project, domain: '') }
+
+      it { expect(auto_devops).not_to have_domain }
+    end
+  end
+
+  describe '#variables' do
     let(:auto_devops) { build_stubbed(:project_auto_devops, project: project, domain: domain) }
 
     context 'when domain is defined' do

spec/views/projects/pipelines_settings/_show.html.haml_spec.rb

+require 'spec_helper'
+
+describe 'projects/pipelines_settings/_show' do
+  let(:project) { create(:project, :repository) }
+
+  before do
+    assign :project, project
+  end
+
+  context 'when kubernetes is not active' do
+    context 'when auto devops domain is not defined' do
+      it 'shows warning message' do
+        render
+
+        expect(rendered).to have_css('.settings-message')
+        expect(rendered).to have_text('Auto Review Apps and Auto Deploy need a domain name and the')
+        expect(rendered).to have_link('Kubernetes service')
+      end
+    end
+
+    context 'when auto devops domain is defined' do
+      before do
+        project.build_auto_devops(domain: 'example.com')
+      end
+
+      it 'shows warning message' do
+        render
+
+        expect(rendered).to have_css('.settings-message')
+        expect(rendered).to have_text('Auto Review Apps and Auto Deploy need the')
+        expect(rendered).to have_link('Kubernetes service')
+      end
+    end
+  end
+
+  context 'when kubernetes is active' do
+    before do
+      project.build_kubernetes_service(active: true)
+    end
+
+    context 'when auto devops domain is not defined' do
+      it 'shows warning message' do
+        render
+
+        expect(rendered).to have_css('.settings-message')
+        expect(rendered).to have_text('Auto Review Apps and Auto Deploy need a domain name to work correctly.')
+      end
+    end
+
+    context 'when auto devops domain is defined' do
+      before do
+        project.build_auto_devops(domain: 'example.com')
+      end
+
+      it 'does not show warning message' do
+        render
+
+        expect(rendered).not_to have_css('.settings-message')
+      end
+    end
+  end
+end