buildkite-builder 3.9.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38dd50aa0554deb37552ff778d49fd94bd4e22e242ae72ccf179fdcf3460cf25
-  data.tar.gz: a134a4f33462478c35b965c4dbbdb4451cfd4b383817150fc192301fada635af
+  metadata.gz: c1f1ed1d180d7e0682417a8ada846785b485c32af561a442c9d2e6370975de1f
+  data.tar.gz: c618bcd175b11c4dccb1b1f40d642ce7286b05b5c5d9fd42693e060d0602c2f4
 SHA512:
-  metadata.gz: '02599590709a1ca3f7e19da232889b3bf26ff316ff48dc10b8ec3751efc1e08c39a3bf05c6eee21bc2d6463b296d8d777d1d89f5b55abd6ad1667ec89925fa8f'
-  data.tar.gz: a8b4e2b45030b631e1bbb9da80954a7debc9d056945e1e57f36b1df51e88fa68812bb3c99e3826536df356a0520d3e0fe830aa98fd7bea7f88a02dece853253e
+  metadata.gz: 4e45d32dfedd02df0fba24ba0ac59ae388dc4c4d909e26c7fa6672944ba637959352a73619b6629b9d5ea3c89b94a974f93a1c50c182a08bf9ede5092438fb52
+  data.tar.gz: d428745b5ffd07191f5bcd375ff7aaa4043ccc2fda09733c3569f34658b377b00cdd63d3ea8b46c0d1ce28524519a6c9701e44c720afee4c9393da8f4d4de17d

data/README.md

@@ -135,36 +135,6 @@ Buildkite::Builder.pipeline do
 end
 ```
 
-### Subpipeline
-
-While triggering another pipeline, you can predefine subpipeline's steps using `pipeline(NAME_OF_SUBPIPELINE)` in the main pipeline's `pipeline.rb` file and share with main pipeline's plugins and templates definition.
-
-`.buildkite/pipelines/pipeline-triggerer/pipeline.rb`
-
-```ruby
-Buildkite::Builder.pipeline do
-  pipeline('rspec-pipeline') do
-    command do
-      label "Run RSpec in separate pipeline"
-    end
-  end
-end
-```
-
-Inside your Buildkite pipeline setup, you can do the following:
-
-In `https://buildkite.com/your-org/rspec-pipeline/steps`
-
-```yaml
-steps:
-  - label: ":pipeline:"
-    commands:
-      - buildkite-agent artifact download $BKB_SUBPIPELINE_FILE . --build $BUILDKITE_TRIGGERED_FROM_BUILD_ID
-      - buildkite-agent pipeline upload $BKB_SUBPIPELINE_FILE
-```
-
-This will upload the pregenerated `pipeline.yml` to `rspec-pipeline`.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/VERSION

@@ -1 +1 @@
-3.9.0
+4.1.0

data/lib/buildkite/builder/extension.rb

@@ -14,12 +14,12 @@ module Buildkite
 
       attr_reader :context
       attr_reader :options
-      attr_reader :option_block
+      attr_reader :options_block
 
       def initialize(context, **options, &block)
         @context = context
         @options = options
-        @option_block = block
+        @options_block = block
 
         prepare
       end

data/lib/buildkite/builder/extension_manager.rb

@@ -8,7 +8,7 @@ module Buildkite
         @context = context
         @extensions = {}
 
-        @loader = Loaders::Extensions.load(@context.root)
+        Loaders::Extensions.load(@context.root)
       end
 
       def use(extension, native: false, **args, &block)
@@ -34,6 +34,10 @@ module Buildkite
         @extensions.fetch(klass)
       end
 
+      def all
+        @extensions.keys
+      end
+
       private
 
       def log

data/lib/buildkite/builder/extensions/plugins.rb

@@ -23,17 +23,6 @@ module Buildkite
               resource.is_a?(Symbol) ? manager.build(resource, attributes) : plugin
             end
           end
-
-          context.data.pipelines.each do |pipeline|
-            pipeline.data.steps.each(:command) do |step|
-              next unless step.has?(:plugins)
-
-              step.get(:plugins).map! do |plugin|
-                resource, attributes = extract_resource_and_attributes(plugin)
-                resource.is_a?(Symbol) ? manager.build(resource, attributes) : plugin
-              end
-            end
-          end
         end
 
         private

data/lib/buildkite/builder/extensions/steps.rb

@@ -2,54 +2,67 @@ module Buildkite
   module Builder
     module Extensions
       class Steps < Extension
+        attr_reader :templates
+
         def prepare
-          context.data.steps = StepCollection.new(TemplateManager.new(context.root))
+          @templates = TemplateManager.new(context.root)
+          context.data.steps = StepCollection.new
         end
 
-        dsl do
-          def group(label = nil, emoji: nil, &block)
-            raise "Group does not allow nested in another Group" if context.is_a?(Group)
+        def build_step(step_class, template_name, **args, &block)
+          template = @templates.find(template_name)
+
+          step_class.new(**args).tap do |step|
+            step.process(template) if template
+            step.process(block) if block_given?
 
-            if emoji
-              emoji = Array(emoji).map { |name| ":#{name}:" }.join
-              label = [emoji, label].compact.join(' ')
+            if @current_group
+              @current_group.steps.push(step)
+            else
+              context.data.steps.push(step)
             end
+          end
+        end
+
+        def with_group(group, &block)
+          raise "Group cannot be nested" if @current_group
 
-            context.data.steps.push(Buildkite::Builder::Group.new(label, context, &block))
+          @current_group = group
+
+          group.process(block)
+          context.data.steps.push(group).last
+        ensure
+          @current_group = nil
+        end
+
+        dsl do
+          def group(&block)
+            context.extensions.find(Steps).with_group(Pipelines::Steps::Group.new(context), &block)
           end
 
           def block(template = nil, **args, &block)
-            context.data.steps.add(Pipelines::Steps::Block, template, **args, &block)
+            context.extensions.find(Steps).build_step(Pipelines::Steps::Block, template, **args, &block)
           end
 
           def command(template = nil, **args, &block)
-            context.data.steps.add(Pipelines::Steps::Command, template, **args, &block)
+            context.extensions.find(Steps).build_step(Pipelines::Steps::Command, template, **args, &block)
           end
 
           def input(template = nil, **args, &block)
-            context.data.steps.add(Pipelines::Steps::Input, template, **args, &block)
+            context.extensions.find(Steps).build_step(Pipelines::Steps::Input, template, **args, &block)
           end
 
           def trigger(template = nil, **args, &block)
-            context.data.steps.add(Pipelines::Steps::Trigger, template, **args, &block)
-          end
-
-          def skip(template = nil, **args, &block)
-            step = context.data.steps.add(Pipelines::Steps::Skip, template, **args, &block)
-            # A skip step has a nil/noop command.
-            step.command(nil)
-            # Always set the skip attribute if it's in a falsey state.
-            step.skip(true) if !step.get(:skip) || step.skip.empty?
-            step
+            context.extensions.find(Steps).build_step(Pipelines::Steps::Trigger, template, **args, &block)
           end
 
           def wait(attributes = {}, &block)
-            step = context.data.steps.add(Pipelines::Steps::Wait, &block)
-            step.wait(nil)
-            attributes.each do |key, value|
-              step.set(key, value)
+            context.extensions.find(Steps).build_step(Pipelines::Steps::Wait, nil, &block).tap do |step|
+              step.wait(nil)
+              attributes.each do |key, value|
+                step.set(key, value)
+              end
             end
-            step
           end
         end
       end

data/lib/buildkite/builder/extensions.rb

@@ -6,7 +6,6 @@ module Buildkite
       autoload :Env, File.expand_path('extensions/env', __dir__)
       autoload :Lib, File.expand_path('extensions/lib', __dir__)
       autoload :Notify, File.expand_path('extensions/notify', __dir__)
-      autoload :SubPipelines, File.expand_path('extensions/sub_pipelines', __dir__)
       autoload :Steps, File.expand_path('extensions/steps', __dir__)
       autoload :Plugins, File.expand_path('extensions/plugins', __dir__)
       autoload :Use, File.expand_path('extensions/use', __dir__)

data/lib/buildkite/builder/pipeline.rb

@@ -19,7 +19,6 @@ module Buildkite
       attr_reader :logger,
                   :root,
                   :artifacts,
-                  :plugins,
                   :dsl,
                   :data,
                   :extensions
@@ -28,7 +27,6 @@ module Buildkite
         @root = root
         @logger = logger || Logger.new(File::NULL)
         @artifacts = []
-        @plugins = {}
         @dsl = Dsl.new(self)
         @extensions = ExtensionManager.new(self)
         @data = Data.new
@@ -39,7 +37,6 @@ module Buildkite
         use(Extensions::Notify)
         use(Extensions::Steps)
         use(Extensions::Plugins)
-        use(Extensions::SubPipelines)
       end
 
       def upload

data/lib/buildkite/builder/step_collection.rb

@@ -1,40 +1,51 @@
 module Buildkite
   module Builder
     class StepCollection
-      attr_reader :templates
+      STEP_TYPES = {
+        block: Pipelines::Steps::Block,
+        command: Pipelines::Steps::Command,
+        group: Pipelines::Steps::Group,
+        input: Pipelines::Steps::Input,
+        trigger: Pipelines::Steps::Trigger,
+        wait: Pipelines::Steps::Wait
+      }.freeze
+
       attr_reader :steps
 
-      def initialize(templates)
-        @templates = templates
+      def initialize
         @steps = []
       end
 
-      def each(*types)
+      def each(*types, &block)
         types = types.flatten
+        types.map! { |type| STEP_TYPES.values.include?(type) ? type : STEP_TYPES.fetch(type) }
+        types = STEP_TYPES.values if types.empty?
 
-        @steps.each do |step|
-          if types.include?(step.class.to_sym)
-            yield step
-          elsif step.is_a?(Group)
-            step.data.steps.each(*types) do |step|
-              yield step
-            end
-          elsif types.empty?
-            yield step
+        matched_steps = steps.each_with_object([]) do |step, matches|
+          if types.any? { |step_type| step.is_a?(step_type) }
+            matches << step
+          end
+          if step.is_a?(Pipelines::Steps::Group)
+            step.steps.each(types) { |step| matches << step }
           end
         end
+        matched_steps.each(&block)
       end
 
       def find(key)
-        @steps.find { |step| step.has?(:key) && step.key == key.to_s }
+        steps.find { |step| step.has?(:key) && step.key.to_s == key.to_s }
       end
 
-      def find!(key)
-        find(key) || raise(ArgumentError, "Can't find step with key: #{key}")
+      def remove(step)
+        steps.delete(step)
       end
 
-      def add(step_class, template = nil, **args, &block)
-        @steps.push(step_class.new(self, template, **args, &block)).last
+      def replace(old_step, new_step)
+        steps[steps.index(old_step)] = new_step
+      end
+
+      def find!(key)
+        find(key) || raise(ArgumentError, "Can't find step with key: #{key}")
       end
 
       def push(step)

data/lib/buildkite/builder/template_manager.rb

@@ -18,10 +18,6 @@ module Buildkite
 
         definition
       end
-
-      def to_definition
-        # No-op
-      end
     end
   end
 end

data/lib/buildkite/builder.rb

@@ -5,7 +5,6 @@ require 'pathname'
 module Buildkite
   module Builder
     autoload :Commands, File.expand_path('builder/commands', __dir__)
-    autoload :Group, File.expand_path('builder/group', __dir__)
     autoload :Pipeline, File.expand_path('builder/pipeline', __dir__)
     autoload :Definition, File.expand_path('builder/definition', __dir__)
     autoload :Data, File.expand_path('builder/data', __dir__)

data/lib/buildkite/pipelines/steps/abstract.rb

@@ -11,20 +11,16 @@ module Buildkite
 
         def_delegator :@context, :data
 
-        attr_reader :template
-        attr_reader :step_collection
-
         def self.to_sym
           name.split('::').last.downcase.to_sym
         end
 
-        def initialize(step_collection, template_name, **args, &block)
-          @step_collection = step_collection
-          @template = step_collection.templates.find(template_name)
+        def initialize(**args)
           @context = StepContext.new(self, **args)
+        end
 
-          instance_exec(@context, &template) if template
-          instance_exec(@context, &block) if block_given?
+        def process(block)
+          instance_exec(@context, &block)
         end
       end
     end

data/lib/buildkite/pipelines/steps/group.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Pipelines
+    module Steps
+      class Group < Abstract
+        attribute :depends_on, append: true
+        attribute :key
+        attribute :label
+
+        attr_reader :steps
+
+        def initialize(pipeline, **args)
+          @pipeline = pipeline
+          @context = StepContext.new(self, **args)
+          @steps = Buildkite::Builder::StepCollection.new
+        end
+
+        def method_missing(method_name, ...)
+          if @pipeline.dsl.respond_to?(method_name)
+            @pipeline.dsl.public_send(method_name, ...)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(...)
+          @pipeline.dsl.respond_to?(...) || super
+        end
+
+        def to_h
+          super.merge(group: nil, steps: steps.to_definition)
+        end
+      end
+    end
+  end
+end

data/lib/buildkite/pipelines/steps.rb

@@ -6,8 +6,8 @@ module Buildkite
       autoload :Abstract, File.expand_path('steps/abstract', __dir__)
       autoload :Block, File.expand_path('steps/block', __dir__)
       autoload :Command, File.expand_path('steps/command', __dir__)
+      autoload :Group, File.expand_path('steps/group', __dir__)
       autoload :Input, File.expand_path('steps/input', __dir__)
-      autoload :Skip, File.expand_path('steps/skip', __dir__)
       autoload :Trigger, File.expand_path('steps/trigger', __dir__)
       autoload :Wait, File.expand_path('steps/wait', __dir__)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -115,16 +115,13 @@ files:
 - lib/buildkite/builder/extensions/notify.rb
 - lib/buildkite/builder/extensions/plugins.rb
 - lib/buildkite/builder/extensions/steps.rb
-- lib/buildkite/builder/extensions/sub_pipelines.rb
 - lib/buildkite/builder/extensions/use.rb
-- lib/buildkite/builder/group.rb
 - lib/buildkite/builder/loaders.rb
 - lib/buildkite/builder/loaders/abstract.rb
 - lib/buildkite/builder/loaders/extensions.rb
 - lib/buildkite/builder/loaders/templates.rb
 - lib/buildkite/builder/logging_utils.rb
 - lib/buildkite/builder/pipeline.rb
-- lib/buildkite/builder/pipeline_collection.rb
 - lib/buildkite/builder/plugin.rb
 - lib/buildkite/builder/plugin_manager.rb
 - lib/buildkite/builder/rainbow.rb
@@ -150,8 +147,8 @@ files:
 - lib/buildkite/pipelines/steps/abstract.rb
 - lib/buildkite/pipelines/steps/block.rb
 - lib/buildkite/pipelines/steps/command.rb
+- lib/buildkite/pipelines/steps/group.rb
 - lib/buildkite/pipelines/steps/input.rb
-- lib/buildkite/pipelines/steps/skip.rb
 - lib/buildkite/pipelines/steps/trigger.rb
 - lib/buildkite/pipelines/steps/wait.rb
 homepage: https://github.com/Gusto/buildkite-builder

data/lib/buildkite/builder/extensions/sub_pipelines.rb

@@ -1,104 +0,0 @@
-require 'securerandom'
-
-module Buildkite
-  module Builder
-    module Extensions
-      class SubPipelines < Extension
-        class Pipeline
-          include Buildkite::Pipelines::Attributes
-
-          attr_reader :data, :name, :dsl
-
-          # These attributes are for triggered step
-          attribute :label
-          attribute :key
-          attribute :skip
-          attribute :if, as: :condition
-          attribute :depends_on, append: true
-          attribute :allow_dependency_failure
-          attribute :branches
-          attribute :async
-          attribute :build
-
-          def self.to_sym
-            name.split('::').last.downcase.to_sym
-          end
-
-          def initialize(name, context, &block)
-            @context = context
-            @name = name
-            @data = Data.new
-            @data.steps = StepCollection.new(context.data.steps.templates)
-            @data.notify = []
-            @data.env = {}
-
-            # Use `clone` to copy over dsl's extended extensions
-            @dsl = context.dsl.clone
-            # Override dsl context to current pipeline
-            @dsl.instance_variable_set(:@context, self)
-
-            instance_eval(&block) if block_given?
-            self
-          end
-
-          def to_h
-            # Merge envs from main pipeline, since ruby does not have `reverse_merge` and
-            # `data` does not allow keys override, we have to reset the data hash per key.
-            @context.data.env.merge(data.env).each do |key, value|
-              data.env[key] = value
-            end
-            data.to_definition
-          end
-
-          def method_missing(method_name, *args, **kwargs, &_block)
-            @dsl.public_send(method_name, *args, **kwargs, &_block)
-          end
-
-          def pipeline_yml
-            @pipeline_yml ||= "tmp/buildkite-builder/#{SecureRandom.urlsafe_base64}.yml"
-          end
-        end
-
-        def prepare
-          context.data.pipelines = PipelineCollection.new(context.artifacts)
-        end
-
-        dsl do
-          def pipeline(name, &block)
-            raise "Subpipeline must have a name" if name.empty?
-            raise "Subpipeline does not allow nested in another Subpipeline" if context.is_a?(Buildkite::Builder::Extensions::SubPipelines::Pipeline)
-
-            sub_pipeline = Buildkite::Builder::Extensions::SubPipelines::Pipeline.new(name, context, &block)
-            context.data.pipelines.add(sub_pipeline)
-
-            trigger_step = context.data.steps.add(Pipelines::Steps::Trigger)
-            trigger_step.trigger(name)
-
-            build_options = {
-              message: '${BUILDKITE_MESSAGE}',
-              commit: '${BUILDKITE_COMMIT}',
-              branch: '${BUILDKITE_BRANCH}',
-              env: {
-                BUILDKITE_PULL_REQUEST: '${BUILDKITE_PULL_REQUEST}',
-                BUILDKITE_PULL_REQUEST_BASE_BRANCH: '${BUILDKITE_PULL_REQUEST_BASE_BRANCH}',
-                BUILDKITE_PULL_REQUEST_REPO: '${BUILDKITE_PULL_REQUEST_REPO}',
-                BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml
-              }
-            }
-            build_options.merge!(sub_pipeline.build) if sub_pipeline.build
-
-            trigger_step.build(build_options)
-            trigger_step.key(sub_pipeline.key || "subpipeline_#{name}_#{context.data.pipelines.count}")
-            trigger_step.label(sub_pipeline.label || name.capitalize)
-            trigger_step.async(sub_pipeline.async || false)
-            trigger_step.branches(sub_pipeline.branches) if sub_pipeline.branches
-            trigger_step.condition(sub_pipeline.condition) if sub_pipeline.condition
-            trigger_step.depends_on(*sub_pipeline.get('depends_on')) if sub_pipeline.get('depends_on')
-            trigger_step.allow_dependency_failure(sub_pipeline.allow_dependency_failure || false)
-            trigger_step.skip(sub_pipeline.skip || false)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/buildkite/builder/group.rb

@@ -1,41 +0,0 @@
-module Buildkite
-  module Builder
-    class Group
-      include Buildkite::Pipelines::Attributes
-
-      attr_reader :label
-      attr_reader :data
-
-      attribute :depends_on, append: true
-      attribute :key
-
-      def self.to_sym
-        name.split('::').last.downcase.to_sym
-      end
-
-      def initialize(label, context, &block)
-        @label = label
-        @data = Data.new
-        @data.steps = StepCollection.new(context.data.steps.templates)
-        @data.notify = []
-
-        # Use `clone` to copy over dsl's extended extensions
-        @dsl = context.dsl.clone
-        # Override dsl context to current group
-        @dsl.instance_variable_set(:@context, self)
-
-        instance_eval(&block) if block_given?
-        self
-      end
-
-      def to_h
-        attributes = super
-        { group: label }.merge(attributes).merge(data.to_definition)
-      end
-
-      def method_missing(method_name, *args, **kwargs, &_block)
-        @dsl.public_send(method_name, *args, **kwargs, &_block)
-      end
-    end
-  end
-end

data/lib/buildkite/builder/pipeline_collection.rb

@@ -1,40 +0,0 @@
-require "forwardable"
-
-module Buildkite
-  module Builder
-    class PipelineCollection
-      extend Forwardable
-
-      attr_reader :pipelines
-
-      def_delegator :@pipelines, :count
-      def_delegator :@pipelines, :each
-
-      def initialize(artifacts)
-        @artifacts = artifacts
-        @pipelines = []
-      end
-
-      def add(pipeline)
-        unless pipeline.is_a?(Buildkite::Builder::Extensions::SubPipelines::Pipeline)
-          raise "`#{pipeline}` must be a Buildkite::Builder::Extensions::SubPipelines::Pipeline"
-        end
-
-        pipelines << pipeline
-      end
-
-      def to_definition
-        # Instead of generates pipeline.yml, subpipelines save generated file to artifacts
-        pipelines.each do |pipeline|
-          file = Pathname.new(pipeline.pipeline_yml)
-          file.dirname.mkpath
-          file.write(YAML.dump(Pipelines::Helpers.sanitize(pipeline.to_h)))
-
-          @artifacts << file
-        end
-
-        nil
-      end
-    end
-  end
-end

data/lib/buildkite/pipelines/steps/skip.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Pipelines
-    module Steps
-      class Skip < Abstract
-        # This skip step is not an official Buildkite step. A skip step is really
-        # just a command step that does nothing and is used to portray a hidden
-        # step on the Buildkite web UI.
-        #
-        # Since it is it's own class, pipeline processors will be able to distinguish
-        # between this type of skip and a conditional skip. Conditional skips are
-        # full command or trigger steps skipped by the `skip` attribute. They can be
-        # unskipped in processors for certain situations. See the `DefaultBranch`
-        # processor for example.
-
-        # Do NOT sort this list. The order here is carried over to the YAML output.
-        # The order specified here was deliberate.
-        attribute :label
-        attribute :skip
-        attribute :if, as: :condition
-        attribute :depends_on, append: true
-        attribute :allow_dependency_failure
-        attribute :command
-      end
-    end
-  end
-end