buildkite-builder 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b19e2a9c84be58408585027ddc221dd1b8d6b5f9303085f874a97b460eaf4b7f
-  data.tar.gz: 939afa112be8163360618af03a4d21241b3cdceebef90fee3501052d1258e2cc
+  metadata.gz: bef719c816c5d64756bbcd041ca2a3fabe8fe59bff47cc154948207ce64a672f
+  data.tar.gz: f25762b1422e540f395526df9d6082e1d5908ea0b9b290bf025a365b56c317ff
 SHA512:
-  metadata.gz: 54cb436ddc5a4d68da270ae84e62af8902d15388d2d44edaf6f9cc0473bec0f7744286a8e8d9ed1ed5a9d15e8c46e23928a70a51c3078bc1426adb1a1a54c685
-  data.tar.gz: f67035e4e34f940c2a5b5c2fae14cda001e8185e20e2aa17db7d38574bf3ddcd5bccf47bd6ccf3a96e6325582a88b52cd8594df4a30f080d3eb712863b51ee6f
+  metadata.gz: c00f3fba91b34cf907c99ff839612270ef8aecb754c988af52226e979d5e743a508963d1d06d9957b529a2e3ba47cf6ba0951ec33290b8581dc9937b4178033a
+  data.tar.gz: 6e62bff8ecdb50b72bdb3afb8fd6fa1385f17ef1852b607f5273570cab1d396ee65d8908a78604d48ccb7a564ad4cb0f9dbff6b94b7a016cfd9ee881e1d4098a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+* Add subpipeline support to save triggered pipeline's YML definition beforehand to artifacts and pass down the file to an ENV for pipeline setup.
+
 ## 3.0.0
 * Remove manifest features to prevent Github API dependency and simplify the gem to focus on Buildkite features.
 

data/README.md

@@ -48,7 +48,7 @@ At its core, BKB is really just a YAML builder. This tool allows you to scale yo
 - Perform pre-build code/diff analysis to determine whether or not to to add a step to the pipeline.
 - Reorder pipeline steps dynamically.
 - Augment your pipeline steps with BKB processors.
-  
+
 ### Pipeline Files
 
 Your repo can contain as many pipeline definitions as you'd like. By convention, pipeline file structure are as such:
@@ -74,9 +74,9 @@ Buildkite::Builder.pipeline do
     label "Rspec", emoji: :rspec
     command "bundle exec rspec"
   end
-  
+
   wait
-  
+
   trigger do
     trigger "deploy-pipeline"
   end
@@ -127,7 +127,7 @@ You can then include the template into the the pipeline once or as many time as
 ```ruby
 Buildkite::Builder.pipeline do
   command(:rspec)
-  
+
   # Reuse and agument templates on the fly.
   command(:rspec) do
     label "Run RSpec again!"
@@ -135,6 +135,36 @@ 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.0.0
+3.1.0

data/lib/buildkite/builder/data.rb

@@ -9,7 +9,7 @@ module Buildkite
         @data.each_with_object({}) do |(key, value), hash|
           value = value.respond_to?(:to_definition) ? value.to_definition : value
 
-          next if value.empty?
+          next if value.nil? || value.empty?
 
           hash[key] = value
         end

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

@@ -0,0 +1,96 @@
+require 'securerandom'
+
+module Buildkite
+  module Builder
+    module Extensions
+      class SubPipelines < Extension
+        class Pipeline
+          include Buildkite::Pipelines::Attributes
+
+          attr_reader :data, :name
+
+          attribute :depends_on, append: true
+          attribute :key
+
+          def self.to_sym
+            name.split('::').last.downcase.to_sym
+          end
+
+          def initialize(name, steps, &block)
+            @name = name
+            @data = Data.new
+            @data.steps = StepCollection.new(
+              steps.templates,
+              steps.plugins
+            )
+            @data.notify = []
+            @data.env = {}
+
+            @dsl = Dsl.new(self)
+            @dsl.extend(Extensions::Steps)
+            @dsl.extend(Extensions::Notify)
+            @dsl.extend(Extensions::Env)
+            instance_eval(&block) if block_given?
+            self
+          end
+
+          def to_h
+            attributes = super
+            attributes.merge(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, template = nil, &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.data.steps, &block)
+
+            context.data.pipelines.add(sub_pipeline)
+
+            if template
+              # Use predefined template
+              step = context.data.steps.add(Pipelines::Steps::Trigger, template)
+
+              if step.build.nil?
+                step.build(env: { BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml })
+              else
+                step.build[:env].merge!(BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml)
+              end
+            else
+              # Generic trigger step
+              context.data.steps.add(Pipelines::Steps::Trigger, key: "subpipeline_#{name}_#{context.data.pipelines.count}") do |context|
+                key context[:key]
+                label name.capitalize
+                trigger name
+                build(
+                  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
+                  }
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extensions.rb

@@ -6,6 +6,7 @@ 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 :Use, File.expand_path('extensions/use', __dir__)
     end

data/lib/buildkite/builder/pipeline.rb

@@ -37,6 +37,7 @@ module Buildkite
         use(Extensions::Env)
         use(Extensions::Notify)
         use(Extensions::Steps)
+        use(Extensions::SubPipelines)
       end
 
       def upload

data/lib/buildkite/builder/pipeline_collection.rb

@@ -0,0 +1,39 @@
+require "forwardable"
+
+module Buildkite
+  module Builder
+    class PipelineCollection
+      extend Forwardable
+
+      attr_reader :pipelines
+
+      def_delegator :@pipelines, :count
+
+      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/builder.rb

@@ -20,6 +20,7 @@ module Buildkite
     autoload :Plugin, File.expand_path('builder/plugin', __dir__)
     autoload :PluginCollection, File.expand_path('builder/plugin_collection', __dir__)
     autoload :StepCollection, File.expand_path('builder/step_collection', __dir__)
+    autoload :PipelineCollection, File.expand_path('builder/pipeline_collection', __dir__)
     autoload :TemplateManager, File.expand_path('builder/template_manager', __dir__)
     autoload :PluginManager, File.expand_path('builder/plugin_manager', __dir__)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -128,6 +128,7 @@ files:
 - lib/buildkite/builder/extensions/lib.rb
 - lib/buildkite/builder/extensions/notify.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
@@ -136,6 +137,7 @@ files:
 - 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_collection.rb
 - lib/buildkite/builder/plugin_manager.rb
@@ -190,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.