Add buildkite_metadata action

Author: AliSoftware

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_metadata_action.rb

@@ -0,0 +1,67 @@
+module Fastlane
+  module Actions
+    class BuildkiteMetadataAction < Action
+      def self.run(params)
+        # Set/Add new metadata values
+        params[:set]&.each do |key, value|
+          sh('buildkite-agent', 'meta-data', 'set', key.to_s, value.to_s)
+        end
+
+        # Return value of existing metadata key
+        sh('buildkite-agent', 'meta-data', 'get', params[:get].to_s) unless params[:get].nil?
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Set/Get metadata to the current Buildkite build'
+      end
+
+      def self.details
+        <<~DETAILS
+          Set and/or get metadata to the current Buildkite build.
+
+          Has to be run on a CI job (where a `buildkite-agent` is running), e.g. typically by a lane
+          that is triggered as part of a Buildkite CI step.
+
+          See https://buildkite.com/docs/agent/v3/cli-meta-data
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :set,
+            env_name: 'BUILDKITE_METADATA_SET',
+            description: 'The hash of key/value pairs of the meta-data to set',
+            type: Hash,
+            optional: true,
+            default_value: nil
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :get,
+            env_name: 'BUILDKITE_METADATA_GET',
+            description: 'The key of the metadata to get the value of',
+            type: String,
+            optional: true,
+            default_value: nil
+          ),
+        ]
+      end
+
+      def self.return_value
+        'The value of the Buildkite metadata corresponding to the provided `get` key. `nil` if no `get` parameter was provided.'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

spec/buildkite_metadata_action_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Fastlane::Actions::BuildkiteMetadataAction do
+  it 'calls the right command to set a single metadata' do
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'set', 'foo', 'bar')
+
+    res = run_described_fastlane_action(set: { foo: 'bar' })
+    expect(res).to be_nil
+  end
+
+  it 'calls the commands as many times as necessary when we want to set multiple metadata at once' do
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'set', 'key1', 'value1')
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'set', 'key2', 'value2')
+
+    metadata = {
+      key1: 'value1',
+      key2: 'value2'
+    }
+    run_described_fastlane_action(set: metadata)
+  end
+
+  it 'calls the right command to get the value of metadata, and returns the right value' do
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'get', 'foo')
+    allow(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'get', 'foo').and_return('foo value')
+
+    res = run_described_fastlane_action(get: 'foo')
+    expect(res).to eq('foo value')
+  end
+
+  it 'allows both setting and getting metadata in the same call' do
+    # Might not be the main way we intend to use this action… but it's still supported.
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'set', 'key1', 'value1')
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'set', 'key2', 'value2')
+    expect(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'get', 'key3')
+    allow(Fastlane::Action).to receive(:sh).with('buildkite-agent', 'meta-data', 'get', 'key3').and_return('value3')
+
+    new_metadata = {
+      key1: 'value1',
+      key2: 'value2'
+    }
+    res = run_described_fastlane_action(set: new_metadata, get: 'key3')
+
+    expect(res).to eq('value3')
+  end
+end