Merge branch '223135-add-ref-milestones-and-released_at-to-releaser-cli-and-yml' into 'master'

Add `ref`, `milestones` and `released_at` to release yml

See merge request gitlab-org/gitlab!34943

changelogs/unreleased/223135-add-ref-milestones-and-released_at-to-releaser-cli-and-yml.yml

+---
+title: Add ref, released_at, milestones to release yml
+merge_request: 34943
+author:
+type: added

changelogs/unreleased/223135-expose-ref-milestones-relesed-at-to-cli.yml

+---
+title: Expose ref, milestones, released_at to releaser-cli
+merge_request: 35115
+author:
+type: added

lib/gitlab/ci/build/releaser.rb

@@ -5,6 +5,8 @@ module Gitlab
     module Build
       class Releaser
         BASE_COMMAND = 'release-cli create'
+        SINGLE_FLAGS = %i[name description tag_name ref released_at].freeze
+        ARRAY_FLAGS = %i[milestones].freeze
 
         attr_reader :config
 
@@ -14,10 +16,21 @@ module Gitlab
 
         def script
           command = BASE_COMMAND.dup
-          config.each { |k, v| command.concat(" --#{k.to_s.dasherize} \"#{v}\"") }
+          single_flags.each { |k, v| command.concat(" --#{k.to_s.dasherize} \"#{v}\"") }
+          array_commands.each { |k, v| v.each { |elem| command.concat(" --#{k.to_s.singularize.dasherize} \"#{elem}\"") } }
 
           [command]
         end
+
+        private
+
+        def single_flags
+          config.slice(*SINGLE_FLAGS)
+        end
+
+        def array_commands
+          config.slice(*ARRAY_FLAGS)
+        end
       end
     end
   end

lib/gitlab/ci/config/entry/release.rb

@@ -12,8 +12,9 @@ module Gitlab
           include ::Gitlab::Config::Entry::Validatable
           include ::Gitlab::Config::Entry::Attributable
 
-          ALLOWED_KEYS = %i[tag_name name description assets].freeze
-          attributes %i[tag_name name assets].freeze
+          ALLOWED_KEYS = %i[tag_name name description ref released_at milestones assets].freeze
+          attributes %i[tag_name name ref milestones assets].freeze
+          attr_reader :released_at
 
           # Attributable description conflicts with
           # ::Gitlab::Config::Entry::Node.description
@@ -29,8 +30,25 @@ module Gitlab
 
           validations do
             validates :config, allowed_keys: ALLOWED_KEYS
-            validates :tag_name, presence: true
+            validates :tag_name, type: String, presence: true
             validates :description, type: String, presence: true
+            validates :milestones, array_of_strings_or_string: true, allow_blank: true
+            validate do
+              next unless config[:released_at]
+
+              begin
+                @released_at = DateTime.iso8601(config[:released_at])
+              rescue ArgumentError
+                errors.add(:released_at, "must be a valid datetime")
+              end
+            end
+            validate do
+              next unless config[:ref]
+
+              unless Commit.reference_valid?(config[:ref])
+                errors.add(:ref, "must be a valid ref")
+              end
+            end
           end
 
           def value

spec/lib/gitlab/ci/build/releaser_spec.rb

@@ -13,13 +13,15 @@ describe Gitlab::Ci::Build::Releaser do
             name: 'Release $CI_COMMIT_SHA',
             description: 'Created using the release-cli $EXTRA_DESCRIPTION',
             tag_name: 'release-$CI_COMMIT_SHA',
-            ref: '$CI_COMMIT_SHA'
+            ref: '$CI_COMMIT_SHA',
+            milestones: %w[m1 m2 m3],
+            released_at: '2020-07-15T08:00:00Z'
           }
         }
       end
 
       it 'generates the script' do
-        expect(subject).to eq(['release-cli create --name "Release $CI_COMMIT_SHA" --description "Created using the release-cli $EXTRA_DESCRIPTION" --tag-name "release-$CI_COMMIT_SHA" --ref "$CI_COMMIT_SHA"'])
+        expect(subject).to eq(['release-cli create --name "Release $CI_COMMIT_SHA" --description "Created using the release-cli $EXTRA_DESCRIPTION" --tag-name "release-$CI_COMMIT_SHA" --ref "$CI_COMMIT_SHA" --released-at "2020-07-15T08:00:00Z" --milestone "m1" --milestone "m2" --milestone "m3"'])
       end
     end
 
@@ -27,10 +29,12 @@ describe Gitlab::Ci::Build::Releaser do
       using RSpec::Parameterized::TableSyntax
 
       where(:node_name, :node_value, :result) do
-        'name' | 'Release $CI_COMMIT_SHA' | 'release-cli create --name "Release $CI_COMMIT_SHA"'
-        'description' | 'Release-cli $EXTRA_DESCRIPTION' | 'release-cli create --description "Release-cli $EXTRA_DESCRIPTION"'
-        'tag_name' | 'release-$CI_COMMIT_SHA' | 'release-cli create --tag-name "release-$CI_COMMIT_SHA"'
-        'ref' | '$CI_COMMIT_SHA' | 'release-cli create --ref "$CI_COMMIT_SHA"'
+        :name        | 'Release $CI_COMMIT_SHA'         | 'release-cli create --name "Release $CI_COMMIT_SHA"'
+        :description | 'Release-cli $EXTRA_DESCRIPTION' | 'release-cli create --description "Release-cli $EXTRA_DESCRIPTION"'
+        :tag_name    | 'release-$CI_COMMIT_SHA'         | 'release-cli create --tag-name "release-$CI_COMMIT_SHA"'
+        :ref         | '$CI_COMMIT_SHA'                 | 'release-cli create --ref "$CI_COMMIT_SHA"'
+        :milestones  | %w[m1 m2 m3]                     | 'release-cli create --milestone "m1" --milestone "m2" --milestone "m3"'
+        :released_at | '2020-07-15T08:00:00Z'           | 'release-cli create --released-at "2020-07-15T08:00:00Z"'
       end
 
       with_them do

spec/lib/gitlab/ci/config/entry/release_spec.rb

@@ -5,10 +5,7 @@ require 'spec_helper'
 RSpec.describe Gitlab::Ci::Config::Entry::Release do
   let(:entry) { described_class.new(config) }
 
-  describe 'validation' do
-    context 'when entry config value is correct' do
-      let(:config) { { tag_name: 'v0.06', description: "./release_changelog.txt" } }
-
+  shared_examples_for 'a valid entry' do
     describe '#value' do
       it 'returns release configuration' do
         expect(entry.value).to eq config
@@ -22,6 +19,20 @@ RSpec.describe Gitlab::Ci::Config::Entry::Release do
     end
   end
 
+  shared_examples_for 'reports error' do |message|
+    it 'reports error' do
+      expect(entry.errors)
+        .to include message
+    end
+  end
+
+  describe 'validation' do
+    context 'when entry config value is correct' do
+      let(:config) { { tag_name: 'v0.06', description: "./release_changelog.txt" } }
+
+      it_behaves_like 'a valid entry'
+    end
+
     context "when value includes 'assets' keyword" do
       let(:config) do
         {
@@ -36,38 +47,116 @@ RSpec.describe Gitlab::Ci::Config::Entry::Release do
         }
       end
 
-      describe '#value' do
-        it 'returns release configuration' do
-          expect(entry.value).to eq config
+      it_behaves_like 'a valid entry'
     end
+
+    context "when value includes 'name' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME"
+        }
       end
 
-      describe '#valid?' do
-        it 'is valid' do
-          expect(entry).to be_valid
+      it_behaves_like 'a valid entry'
     end
+
+    context "when value includes 'ref' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME",
+          ref: 'b3235930aa443112e639f941c69c578912189bdd'
+        }
       end
+
+      it_behaves_like 'a valid entry'
     end
 
-    context "when value includes 'name' keyword" do
+    context "when value includes 'released_at' keyword" do
       let(:config) do
         {
           tag_name: 'v0.06',
           description: "./release_changelog.txt",
-          name: "Release $CI_TAG_NAME"
+          name: "Release $CI_TAG_NAME",
+          released_at: '2019-03-15T08:00:00Z'
         }
       end
 
-      describe '#value' do
-        it 'returns release configuration' do
-          expect(entry.value).to eq config
+      it_behaves_like 'a valid entry'
     end
+
+    context "when value includes 'milestones' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME",
+          milestones: milestones
+        }
       end
 
-      describe '#valid?' do
-        it 'is valid' do
-          expect(entry).to be_valid
+      context 'for an array of milestones' do
+        let(:milestones) { %w[m1 m2 m3] }
+
+        it_behaves_like 'a valid entry'
       end
+
+      context 'for a single milestone' do
+        let(:milestones) { 'm1' }
+
+        it_behaves_like 'a valid entry'
+      end
+    end
+
+    context "when value includes 'ref' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME",
+          ref: 'b3235930aa443112e639f941c69c578912189bdd'
+        }
+      end
+
+      it_behaves_like 'a valid entry'
+    end
+
+    context "when value includes 'released_at' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME",
+          released_at: '2019-03-15T08:00:00Z'
+        }
+      end
+
+      it_behaves_like 'a valid entry'
+    end
+
+    context "when value includes 'milestones' keyword" do
+      let(:config) do
+        {
+          tag_name: 'v0.06',
+          description: "./release_changelog.txt",
+          name: "Release $CI_TAG_NAME",
+          milestones: milestones
+        }
+      end
+
+      context 'for an array of milestones' do
+        let(:milestones) { %w[m1 m2 m3] }
+
+        it_behaves_like 'a valid entry'
+      end
+
+      context 'for a single milestone' do
+        let(:milestones) { 'm1' }
+
+        it_behaves_like 'a valid entry'
       end
     end
 
@@ -76,37 +165,61 @@ RSpec.describe Gitlab::Ci::Config::Entry::Release do
         context 'when value of attribute is invalid' do
           let(:config) { { description: 10 } }
 
-          it 'reports error' do
-            expect(entry.errors)
-              .to include 'release description should be a string'
-          end
+          it_behaves_like 'reports error', 'release description should be a string'
         end
 
         context 'when release description is missing' do
           let(:config) { { tag_name: 'v0.06' } }
 
-          it 'reports error' do
-            expect(entry.errors)
-              .to include "release description can't be blank"
-          end
+          it_behaves_like 'reports error', "release description can't be blank"
         end
 
         context 'when release tag_name is missing' do
           let(:config) { { description: "./release_changelog.txt" } }
 
-          it 'reports error' do
-            expect(entry.errors)
-              .to include "release tag name can't be blank"
-          end
+          it_behaves_like 'reports error', "release tag name can't be blank"
         end
 
         context 'when there is an unknown key present' do
           let(:config) { { test: 100 } }
 
-          it 'reports error' do
-            expect(entry.errors)
-              .to include 'release config contains unknown keys: test'
+          it_behaves_like 'reports error', 'release config contains unknown keys: test'
+        end
+
+        context 'when `released_at` is not a valid date' do
+          let(:config) { { released_at: 'ABC123' } }
+
+          it_behaves_like 'reports error', 'release released at must be a valid datetime'
         end
+
+        context 'when `ref` is not valid' do
+          let(:config) { { ref: 'ABC123' } }
+
+          it_behaves_like 'reports error', 'release ref must be a valid ref'
+        end
+
+        context 'when `milestones` is not an array of strings' do
+          let(:config) { { milestones: [1, 2, 3] } }
+
+          it_behaves_like 'reports error', 'release milestones should be an array of strings or a string'
+        end
+
+        context 'when `released_at` is not a valid date' do
+          let(:config) { { released_at: 'ABC123' } }
+
+          it_behaves_like 'reports error', 'release released at must be a valid datetime'
+        end
+
+        context 'when `ref` is not valid' do
+          let(:config) { { ref: 'ABC123' } }
+
+          it_behaves_like 'reports error', 'release ref must be a valid ref'
+        end
+
+        context 'when `milestones` is not an array of strings' do
+          let(:config) { { milestones: [1, 2, 3] } }
+
+          it_behaves_like 'reports error', 'release milestones should be an array of strings or a string'
         end
       end
     end

spec/lib/gitlab/ci/yaml_processor_spec.rb

@@ -1397,6 +1397,9 @@ module Gitlab
                 tag_name: "$CI_COMMIT_TAG",
                 name: "Release $CI_TAG_NAME",
                 description: "./release_changelog.txt",
+                ref: 'b3235930aa443112e639f941c69c578912189bdd',
+                released_at: '2019-03-15T08:00:00Z',
+                milestones: %w[m1 m2 m3],
                 assets: {
                   links: [
                     {

spec/requests/api/runner_spec.rb

@@ -668,7 +668,7 @@ RSpec.describe API::Runner, :clean_gitlab_redis_shared_state do
                   {
                     "name" => "release",
                     "script" =>
-                    ["release-cli create --ref \"$CI_COMMIT_SHA\" --name \"Release $CI_COMMIT_SHA\" --tag-name \"release-$CI_COMMIT_SHA\" --description \"Created using the release-cli $EXTRA_DESCRIPTION\""],
+                    ["release-cli create --name \"Release $CI_COMMIT_SHA\" --description \"Created using the release-cli $EXTRA_DESCRIPTION\" --tag-name \"release-$CI_COMMIT_SHA\" --ref \"$CI_COMMIT_SHA\""],
                     "timeout" => 3600,
                     "when" => "on_success",
                     "allow_failure" => false