buildkite-builder 1.0.0 → 1.1.0

data/lib/buildkite/builder/processors/abstract.rb

@@ -7,12 +7,12 @@ module Buildkite
         include LoggingUtils
         using Rainbow
 
-        def self.process(runner)
-          new(runner).run
+        def self.process(context)
+          new(context).run
         end
 
-        def initialize(runner)
-          @runner = runner
+        def initialize(context)
+          @context = context
         end
 
         def run
@@ -21,18 +21,18 @@ module Buildkite
 
         private
 
-        attr_reader :runner
+        attr_reader :context
 
         def process
           raise NotImplementedError
         end
 
         def log
-          runner.log
+          context.logger
         end
 
         def pipeline
-          runner.pipeline
+          context.pipeline
         end
 
         def buildkite

data/lib/buildkite/builder/rainbow.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../vendor/rainbow/lib/rainbow/refinement'
+require 'rainbow/refinement'
 
 module Buildkite
   module Builder

data/lib/buildkite/builder/runner.rb

@@ -8,72 +8,47 @@ require 'logger'
 module Buildkite
   module Builder
     class Runner
-      include Definition::Helper
       include LoggingUtils
       using Rainbow
 
-      PIPELINES_PATH = Pathname.new('.buildkite/pipelines').freeze
-      PIPELINE_DEFINITION_PATH = Pathname.new('pipeline.rb').freeze
+      PIPELINES_PATH = Pathname.new('pipelines').freeze
 
       attr_reader :options
 
-      # This entrypoint is for running on CI. It expects certain environment variables to
-      # be set.
-      def self.run
-        new(
-          upload: true,
-          pipeline: Buildkite.env.pipeline_slug
-        ).run
-      end
-
       def initialize(**options)
-        @options = {
-          verbose: true,
-        }.merge(options)
+        @options = options
       end
 
       def run
-        log.info "#{'+++ ' if Buildkite.env}🧰 " + 'Buildkite-builder'.color(:springgreen) + " ─ #{@options[:pipeline].yellow}"
+        log.info "#{'+++ ' if Buildkite.env}🧰 " + 'Buildkite Builder'.color(:springgreen) + " ─ #{@options[:pipeline].yellow}"
+        context = Context.new(root, logger: log)
 
         results = benchmark("\nDone (%s)".color(:springgreen)) do
-          load_manifests
-          load_templates
-          load_processors
-          load_pipeline
-          run_processors
+          context.build
         end
-        log.info results
-
-        upload! if options[:upload]
-        # Always return the pipeline.
+        log.info(results)
 
-        pipeline
-      end
+        if options[:upload]
+          upload(context.pipeline)
+        end
 
-      def pipeline
-        @pipeline ||= Buildkite::Pipelines::Pipeline.new
+        # Always return the pipeline.
+        context.pipeline
       end
 
-      def pipeline_definition
-        @pipeline_definition ||= begin
-          expected = Definition::Pipeline
-          load_definition(Buildkite::Builder.root.join(".buildkite/pipelines/#{options[:pipeline]}").join(PIPELINE_DEFINITION_PATH), expected)
-        end
-      end
+      private
 
       def log
         @log ||= begin
-          Logger.new(options[:verbose] ? $stdout : StringIO.new).tap do |lgr|
-            lgr.formatter = proc do |_severity, _datetime, _progname, msg|
+          Logger.new($stdout).tap do |logger|
+            logger.formatter = proc do |_severity, _datetime, _progname, msg|
               "#{msg}\n"
             end
           end
         end
       end
 
-      private
-
-      def upload!
+      def upload(pipeline)
         Tempfile.create(['pipeline', '.yml']) do |file|
           file.sync = true
           file.write(pipeline.to_yaml)
@@ -85,31 +60,18 @@ module Buildkite
         end
       end
 
-      def load_manifests
-        Loaders::Manifests.load(options[:pipeline]).each do |name, asset|
-          Manifest[name] = asset
-        end
-      end
-
-      def load_templates
-        Loaders::Templates.load(options[:pipeline]).each do |name, asset|
-          pipeline.template(name, &asset)
-        end
-      end
-
-      def load_processors
-        Loaders::Processors.load(options[:pipeline])
-      end
-
-      def run_processors
-        pipeline.processors.each do |processor|
-          processor.process(self)
+      def root
+        @root ||= begin
+          path = Builder.root.join(Builder::BUILDKITE_DIRECTORY_NAME)
+          if options[:pipeline]
+            pipeline_path = path.join(PIPELINES_PATH).join(options[:pipeline])
+            if pipeline_path.directory?
+              path = pipeline_path
+            end
+          end
+          path
         end
       end
-
-      def load_pipeline
-        pipeline.instance_eval(&pipeline_definition)
-      end
     end
   end
 end

data/lib/buildkite/pipelines.rb

@@ -8,6 +8,7 @@ module Buildkite
     autoload :Helpers, File.expand_path('pipelines/helpers', __dir__)
     autoload :Pipeline, File.expand_path('pipelines/pipeline', __dir__)
     autoload :Plugin, File.expand_path('pipelines/plugin', __dir__)
+    autoload :StepContext, File.expand_path('pipelines/step_context', __dir__)
     autoload :Steps, File.expand_path('pipelines/steps', __dir__)
   end
 end

data/lib/buildkite/pipelines/pipeline.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'pathname'
 
 module Buildkite
   module Pipelines
@@ -15,6 +16,7 @@ module Buildkite
         @plugins = {}
         @templates = {}
         @processors = []
+        @notify = []
 
         instance_eval(&definition) if definition
         instance_eval(&block) if block_given?
@@ -26,8 +28,18 @@ module Buildkite
         Steps::Input,
         Steps::Trigger,
       ].each do |type|
-        define_method(type.to_sym) do |template = nil, &block|
-          add(type, template, &block)
+        define_method(type.to_sym) do |template = nil, **args, &block|
+          add(type, template, **args, &block)
+        end
+      end
+
+      def notify(*args)
+        if args.empty?
+          @notify
+        elsif args.first.is_a?(Hash)
+          @notify.push(args.first.transform_keys(&:to_s))
+        else
+          raise ArgumentError, 'value must be hash'
         end
       end
 
@@ -41,8 +53,8 @@ module Buildkite
         end
       end
 
-      def skip(template = nil, &block)
-        step = add(Steps::Skip, template, &block)
+      def skip(template = nil, **args, &block)
+        step = add(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.
@@ -99,9 +111,8 @@ module Buildkite
 
       def to_h
         pipeline = {}
-        if env.any?
-          pipeline[:env] = env
-        end
+        pipeline[:env] = env if env.any?
+        pipeline[:notify] = notify if notify.any?
         pipeline[:steps] = steps.map(&:to_h)
 
         Helpers.sanitize(pipeline)
@@ -113,8 +124,8 @@ module Buildkite
 
       private
 
-      def add(step_class, template = nil, &block)
-        steps.push(step_class.new(self, find_template(template), &block)).last
+      def add(step_class, template = nil, **args, &block)
+        steps.push(step_class.new(self, find_template(template), **args, &block)).last
       end
 
       def find_template(name)

data/lib/buildkite/pipelines/step_context.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Pipelines
+    class StepContext
+      attr_reader :step
+      attr_reader :args
+
+      def initialize(step, **args)
+        @step = step
+        @args = args
+      end
+
+      def pipeline
+        step.pipeline
+      end
+
+      def [](key)
+        args[key]
+      end
+    end
+  end
+end

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

@@ -13,12 +13,13 @@ module Buildkite
           name.split('::').last.downcase.to_sym
         end
 
-        def initialize(pipeline, template = nil, &block)
+        def initialize(pipeline, template = nil, **args, &block)
           @pipeline = pipeline
           @template = template
+          context = StepContext.new(self, **args)
 
-          instance_eval(&template) if template
-          instance_eval(&block) if block_given?
+          instance_exec(context, &template) if template
+          instance_exec(context, &block) if block_given?
         end
       end
     end

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

@@ -14,6 +14,7 @@ module Buildkite
         attribute :allow_dependency_failure
         attribute :branches
         attribute :fields
+        attribute :blocked_state
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,8 +9,106 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Buildkite Builder is a tool that provides projects using Buildkite to
   have dynamic pipeline functionality.
 email:
@@ -35,6 +133,7 @@ files:
 - lib/buildkite/builder/commands/files.rb
 - lib/buildkite/builder/commands/preview.rb
 - lib/buildkite/builder/commands/run.rb
+- lib/buildkite/builder/context.rb
 - lib/buildkite/builder/definition.rb
 - lib/buildkite/builder/file_resolver.rb
 - lib/buildkite/builder/github.rb
@@ -68,6 +167,7 @@ files:
 - lib/buildkite/pipelines/helpers/timeout_in_minutes.rb
 - lib/buildkite/pipelines/pipeline.rb
 - lib/buildkite/pipelines/plugin.rb
+- lib/buildkite/pipelines/step_context.rb
 - lib/buildkite/pipelines/steps.rb
 - lib/buildkite/pipelines/steps/abstract.rb
 - lib/buildkite/pipelines/steps/block.rb
@@ -76,23 +176,6 @@ files:
 - lib/buildkite/pipelines/steps/skip.rb
 - lib/buildkite/pipelines/steps/trigger.rb
 - lib/buildkite/pipelines/steps/wait.rb
-- lib/vendor/rainbow/Changelog.md
-- lib/vendor/rainbow/Gemfile
-- lib/vendor/rainbow/LICENSE
-- lib/vendor/rainbow/README.markdown
-- lib/vendor/rainbow/Rakefile
-- lib/vendor/rainbow/lib/rainbow.rb
-- lib/vendor/rainbow/lib/rainbow/color.rb
-- lib/vendor/rainbow/lib/rainbow/ext/string.rb
-- lib/vendor/rainbow/lib/rainbow/global.rb
-- lib/vendor/rainbow/lib/rainbow/null_presenter.rb
-- lib/vendor/rainbow/lib/rainbow/presenter.rb
-- lib/vendor/rainbow/lib/rainbow/refinement.rb
-- lib/vendor/rainbow/lib/rainbow/string_utils.rb
-- lib/vendor/rainbow/lib/rainbow/version.rb
-- lib/vendor/rainbow/lib/rainbow/wrapper.rb
-- lib/vendor/rainbow/lib/rainbow/x11_color_names.rb
-- lib/vendor/rainbow/rainbow.gemspec
 homepage: https://github.com/Gusto/buildkite-builder
 licenses:
 - MIT
@@ -116,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.2
 signing_key: 
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.