buildkite-builder 1.3.0 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6684f24ab3c156884bcd3055fbddbb7831afa03be9e0b0b2056fbedef023084b
-  data.tar.gz: 64753e7a15224a0b3c161335cfbc9046ecbaa5e015692ace78001eeef550eea3
+  metadata.gz: 7a9777c2d258caf0ee500fee89d04fe9385a9357f2df66f007b60c88bd361afa
+  data.tar.gz: f8a8e77e07fe770231f00bc7d3a693524cb5495f45c0529313737152dd44be1f
 SHA512:
-  metadata.gz: 21b7f849f79acd215f260644f75767143bb10f2eeab88e0edee7c3728024f128b12f421ddd632ed4163fc0501f44051bc065594906d28643642839be934ac152
-  data.tar.gz: 5bfe120d20cb914525c61dba9ddec9b298058e6ccb01a5b6a4a55cccc95cff1fa993753cf65ba1041615d9adcb735ffb4545c7a58987a004cc3638b11d4eeba3
+  metadata.gz: 824bb77591ec310cace0138dd32269cd379ba244ec0283b53cd86d1e6001b24bd0a208c5662bf1b4d171c773e85c0053decfe619431cccbe6c38e24e7badb32d
+  data.tar.gz: 30502c1de926f6e48423b4d254dc82b86248f2bf5c7e290f50bd972b63ef9d9702bbdd0dd4c81f3cd37aa0da5b3f4076402d72d3f6eb5531b662a96cfdbfa3a4

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.5.0
+* Merge `BuildKite::Builder::Context` and `BuildKite::Pipelines::Pipeline` to `BuildKite::Builder::Pipeline` (#37)
+
+## 1.4.1
+* Fix the Github API Builder to account for Buildkite having both `.git` and no file exention repository URIs (#33)
+
+## 1.4.0
+* Fix the `files` command. You now pass in the manifest with the `--manifest` CLI argument.
+
+## 1.3.1
+* Expose `data` from `StepContext` to `Step`
+
 ## 1.3.0
 * Add ability for step to store data in step context
 * Move `upload` from `BuildKite::Builder::Commands::Run` to `BuildKite::Builder::Context`

data/VERSION

@@ -1 +1 @@
-1.3.0
+2.0.0.beta1

data/lib/buildkite/builder.rb

@@ -5,8 +5,14 @@ require 'pathname'
 module Buildkite
   module Builder
     autoload :Commands, File.expand_path('builder/commands', __dir__)
-    autoload :Context, File.expand_path('builder/context', __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__)
+    autoload :Dsl, File.expand_path('builder/dsl', __dir__)
+    autoload :Extension, File.expand_path('builder/extension', __dir__)
+    autoload :ExtensionManager, File.expand_path('builder/extension_manager', __dir__)
+    autoload :Extensions, File.expand_path('builder/extensions', __dir__)
     autoload :FileResolver, File.expand_path('builder/file_resolver', __dir__)
     autoload :Github, File.expand_path('builder/github', __dir__)
     autoload :Loaders, File.expand_path('builder/loaders', __dir__)
@@ -14,6 +20,9 @@ module Buildkite
     autoload :Manifest, File.expand_path('builder/manifest', __dir__)
     autoload :Processors, File.expand_path('builder/processors', __dir__)
     autoload :Rainbow, File.expand_path('builder/rainbow', __dir__)
+    autoload :StepCollection, File.expand_path('builder/step_collection', __dir__)
+    autoload :TemplateRegistry, File.expand_path('builder/template_registry', __dir__)
+    autoload :PluginRegistry, File.expand_path('builder/plugin_registry', __dir__)
 
     BUILDKITE_DIRECTORY_NAME = Pathname.new('.buildkite').freeze
 

data/lib/buildkite/builder/commands.rb

@@ -32,10 +32,10 @@ module Buildkite
         puts <<~HELP
           #{'SYNOPSIS'.bright}
           \t#{'buildkite-builder'.bright} COMMAND [OPTIONS] [PIPELINE]
-  
+
           \t#{'To see available options for specific commands:'.color(:dimgray)}
           \t#{'buildkite-builder'.bright} COMMAND --help
-  
+
           #{'COMMANDS'.bright}
         HELP
         COMMANDS.each do |command, klass|

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

@@ -8,9 +8,9 @@ module Buildkite
       class Abstract
         PIPELINES_DIRECTORY = 'pipelines'
         POSSIBLE_PIPELINE_PATHS = [
-          File.join('.buildkite', Context::PIPELINE_DEFINITION_FILE),
-          File.join('buildkite', Context::PIPELINE_DEFINITION_FILE),
-          File.join(Context::PIPELINE_DEFINITION_FILE)
+          File.join('.buildkite', Pipeline::PIPELINE_DEFINITION_FILE),
+          File.join('buildkite', Pipeline::PIPELINE_DEFINITION_FILE),
+          File.join(Pipeline::PIPELINE_DEFINITION_FILE)
         ].freeze
         POSSIBLE_PIPELINES_PATHS = [
           File.join('.buildkite', PIPELINES_DIRECTORY),
@@ -91,7 +91,7 @@ module Buildkite
 
         def find_root_by_multi_pipeline
           pipelines_path = POSSIBLE_PIPELINES_PATHS.map { |path| Builder.root.join(path) }.find(&:directory?)
-          
+
           if pipelines_path
             if pipeline_slug
               path = pipelines_path.join(pipeline_slug)

data/lib/buildkite/builder/commands/files.rb

@@ -9,14 +9,13 @@ module Buildkite
         self.description = 'Outputs files that match the specified manifest.'
 
         def run
-          pipeline, manifest = ARGV.first.to_s.split('/')
-          if !pipeline || !manifest
-            raise 'You must specify a pipeline and a manifest (eg "mypipeline/mymanifest")'
-          end
+          manifests = Loaders::Manifests.load(pipeline_path)
+          puts manifests[options[:manifest]].files.sort.join("\n")
+        end
 
-          manifests = Loaders::Manifests.load(pipeline)
-          manifests[manifest].files.each do |file|
-            puts file
+        def parse_options(opts)
+          opts.on('--manifest MANIFEST', 'The manifest to use') do |manifest|
+            options[:manifest] = manifest
           end
         end
       end

data/lib/buildkite/builder/commands/preview.rb

@@ -9,7 +9,7 @@ module Buildkite
         self.description = 'Outputs the pipeline YAML.'
 
         def run
-          puts Context.build(pipeline_path).pipeline.to_yaml
+          puts Pipeline.build(pipeline_path).to_yaml
         end
       end
     end

data/lib/buildkite/builder/commands/run.rb

@@ -16,7 +16,7 @@ module Buildkite
           # This entrypoint is for running on CI. It expects certain environment
           # variables to be set. It also uploads the pipeline to Buildkite.
           log.info "#{'+++ ' if Buildkite.env}🧰 " + 'Buildkite Builder'.color(:springgreen) + " ─ #{relative_pipeline_path.to_s.yellow}"
-          Context.new(pipeline_path, logger: log).upload
+          Pipeline.new(pipeline_path, logger: log).upload
         end
 
         private

data/lib/buildkite/builder/data.rb

@@ -0,0 +1,41 @@
+module Buildkite
+  module Builder
+    class Data
+      def initialize
+        @data = Hash.new
+      end
+
+      def to_definition
+        @data.each_with_object({}) do |(key, value), hash|
+          value = value.respond_to?(:to_definition) ? value.to_definition : value
+
+          next if value.empty?
+
+          hash[key] = value
+        end
+      end
+
+      private
+
+      def method_missing(name, *args, &block)
+        if name.end_with?('=')
+          name = name.to_s.delete_suffix('=').to_sym
+
+          if respond_to_missing?(name)
+            raise ArgumentError, "Data already contains key '#{name}'"
+          else
+            return @data[name] = args.first
+          end
+        elsif respond_to_missing?(name)
+          return @data[name]
+        end
+
+        super
+      end
+
+      def respond_to_missing?(name, *)
+        @data.key?(name)
+      end
+    end
+  end
+end

data/lib/buildkite/builder/dsl.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Builder
+    class Dsl
+      attr_reader :context
+
+      def extend(mod)
+        mod < Extension ? super(mod.dsl) : super
+      end
+
+      def initialize(context)
+        @context = context
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extension.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Builder
+    class Extension
+      class << self
+        attr_reader :dsl
+
+        def dsl(&block)
+          @dsl = Module.new(&block) if block_given?
+          @dsl
+        end
+      end
+
+      attr_reader :context
+      attr_reader :options
+
+      def initialize(context, **options)
+        @context = context
+        @options = options
+
+        prepare
+      end
+
+      def build
+        # Override to provide extra functionality.
+      end
+
+      private
+
+      def buildkite
+        @buildkite ||= begin
+          unless Buildkite.env
+            raise 'Must be in Buildkite environment to access the Buildkite API'
+          end
+
+          Buildkite::Pipelines::Api.new(Buildkite.env.api_token)
+        end
+      end
+
+      def prepare
+        # Override to provide extra functionality.
+      end
+
+      def pipeline(&block)
+        context.dsl.instance_eval(&block) if block_given?
+        context
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extension_manager.rb

@@ -0,0 +1,55 @@
+module Buildkite
+  module Builder
+    class ExtensionManager
+      include LoggingUtils
+      using Rainbow
+
+      def initialize(context)
+        @context = context
+        @extensions = []
+
+        Loaders::Extensions.load(@context.root)
+      end
+
+      def use(extension, **args)
+        unless extension < Buildkite::Builder::Extension
+          raise "#{extension} must subclass Buildkite::Builder::Extension"
+        end
+
+        @extensions.push(extension.new(@context, **args))
+        @context.dsl.extend(extension)
+      end
+
+      def build
+        @extensions.each do |extension|
+          log_build(extension.class.name) { extension.build }
+        end
+      end
+
+      private
+
+      def log
+        @context.logger
+      end
+
+      def log_build(name)
+        log.info "\nProcessing ".color(:dimgray) + name.color(:springgreen)
+
+        results = benchmark('└──'.color(:springgreen) + ' Finished in %s'.color(:dimgray)) do
+          formatter = log.formatter
+          log.formatter = proc do |_severity, _datetime, _progname, msg|
+            '│'.color(:springgreen) + " #{msg}\n"
+          end
+
+          begin
+            yield
+          ensure
+            log.formatter = formatter
+          end
+        end
+
+        log.info results
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extensions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Builder
+    module Extensions
+      autoload :Env, File.expand_path('extensions/env', __dir__)
+      autoload :Notify, File.expand_path('extensions/notify', __dir__)
+      autoload :Steps, File.expand_path('extensions/steps', __dir__)
+      autoload :Use, File.expand_path('extensions/use', __dir__)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Env < Extension
+        def prepare
+          context.data.env = {}
+        end
+
+        dsl do
+          def env(*args)
+            if args.first.is_a?(Hash)
+              context.data.env.merge!(args.first.transform_keys(&:to_s))
+            else
+              raise ArgumentError, 'value must be hash'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Notify < Extension
+        def prepare
+          context.data.notify = []
+        end
+
+        dsl do
+          def notify(*args)
+            if args.first.is_a?(Hash)
+              context.data.notify.push(args.first.transform_keys(&:to_s))
+            else
+              raise ArgumentError, 'value must be hash'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Steps < Extension
+        def prepare
+          context.data.steps = StepCollection.new(
+            TemplateRegistry.new(context.root),
+            PluginRegistry.new
+          )
+        end
+
+        dsl do
+          def group(label = nil, &block)
+            raise "Group does not allow nested in another Group" if context.is_a?(Group)
+
+            context.data.steps.push(Buildkite::Builder::Group.new(label, context.data.steps, &block))
+          end
+
+          def plugin(name, uri, version)
+            context.data.steps.plugins.add(name, uri, version)
+          end
+
+          def block(template = nil, **args, &block)
+            context.data.steps.add(Pipelines::Steps::Block, template, **args, &block)
+          end
+
+          def command(template = nil, **args, &block)
+            context.data.steps.add(Pipelines::Steps::Command, template, **args, &block)
+          end
+
+          def input(template = nil, **args, &block)
+            context.data.steps.add(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
+          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)
+            end
+            step
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Use < Extension
+        dsl do
+          def use(extension_class, **args)
+            context.use(extension_class, **args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/buildkite/builder/github.rb

@@ -11,7 +11,7 @@ module Buildkite
       ACCEPT_HEADER = 'application/vnd.github.v3+json'
       LINK_HEADER = 'link'
       NEXT_LINK_REGEX = /<(?<uri>.+)>; rel="next"/.freeze
-      REPO_REGEX = /github\.com(?::|\/)(.*)\.git\z/.freeze
+      REPO_REGEX = /github\.com(?::|\/)(.*?)(?:\.git)?\z/.freeze
       PER_PAGE = 100
 
       def self.pull_request_files

data/lib/buildkite/builder/group.rb

@@ -0,0 +1,41 @@
+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, steps, &block)
+        @label = label
+        @data = Data.new
+        @data.steps = StepCollection.new(
+          steps.templates,
+          steps.plugins
+        )
+        @data.notify = []
+
+        @dsl = Dsl.new(self)
+        @dsl.extend(Extensions::Steps)
+        @dsl.extend(Extensions::Notify)
+        instance_eval(&block)
+      end
+
+      def to_h
+        attributes = super
+        { group: label }.merge(attributes).merge(data.to_definition)
+      end
+
+      def method_missing(method_name, *_args, &_block)
+        @dsl.public_send(method_name, *_args, &_block)
+      end
+    end
+  end
+end

data/lib/buildkite/builder/loaders.rb

@@ -6,7 +6,7 @@ module Buildkite
       autoload :Abstract, File.expand_path('loaders/abstract', __dir__)
       autoload :Manifests, File.expand_path('loaders/manifests', __dir__)
       autoload :Templates, File.expand_path('loaders/templates', __dir__)
-      autoload :Processors, File.expand_path('loaders/processors', __dir__)
+      autoload :Extensions, File.expand_path('loaders/extensions', __dir__)
     end
   end
 end

data/lib/buildkite/builder/loaders/{processors.rb → extensions.rb}

@@ -5,17 +5,17 @@ require 'pathname'
 module Buildkite
   module Builder
     module Loaders
-      class Processors < Abstract
-        PROCESSORS_PATH = Pathname.new('processors').freeze
+      class Extensions < Abstract
+        EXTENSIONS_PATH = Pathname.new('extensions').freeze
 
         def load
-          load_processors_from_path(global_processors_path)
-          load_processors_from_path(pipeline_processors_path)
+          load_extensions_from_path(global_extensions_path)
+          load_extensions_from_path(pipeline_extensions_path)
         end
 
         private
 
-        def load_processors_from_path(path)
+        def load_extensions_from_path(path)
           return unless path.directory?
 
           path.children.map do |file|
@@ -24,12 +24,12 @@ module Buildkite
           end
         end
 
-        def global_processors_path
-          buildkite_path.join(PROCESSORS_PATH)
+        def global_extensions_path
+          buildkite_path.join(EXTENSIONS_PATH)
         end
 
-        def pipeline_processors_path
-          root.join(PROCESSORS_PATH)
+        def pipeline_extensions_path
+          root.join(EXTENSIONS_PATH)
         end
       end
     end

data/lib/buildkite/builder/{context.rb → pipeline.rb}

@@ -1,59 +1,56 @@
 require 'logger'
 require 'tempfile'
+require 'yaml'
+require 'pathname'
+require 'forwardable'
 
 module Buildkite
   module Builder
-    class Context
+    class Pipeline
+      extend Forwardable
       include Definition::Helper
       include LoggingUtils
       using Rainbow
 
       PIPELINE_DEFINITION_FILE = Pathname.new('pipeline.rb').freeze
 
-      attr_reader :logger
-      attr_reader :root
-      attr_reader :pipeline
-      attr_reader :artifacts
+      def_delegator :@extensions, :use
+
+      attr_reader :logger,
+                  :root,
+                  :artifacts,
+                  :plugins,
+                  :dsl,
+                  :data
 
       def self.build(root, logger: nil)
-        context = new(root, logger: logger)
-        context.build
-        context
+        new(root, logger: logger)
       end
 
       def initialize(root, logger: nil)
         @root = root
         @logger = logger || Logger.new(File::NULL)
         @artifacts = []
-      end
-
-      def build
-        results = benchmark("\nDone (%s)".color(:springgreen)) do
-          unless @pipeline
-            @pipeline = Pipelines::Pipeline.new
-
-            load_manifests
-            load_templates
-            load_processors
-            load_pipeline
-            run_processors
-          end
-        end
-        logger.info(results)
-
-        @pipeline
+        @plugins = {}
+        @dsl = Dsl.new(self)
+        @extensions = ExtensionManager.new(self)
+        @data = Data.new
+
+        use(Extensions::Use)
+        use(Extensions::Env)
+        use(Extensions::Notify)
+        use(Extensions::Steps)
+        load_manifests
       end
 
       def upload
-        build unless @pipeline
-
         logger.info '+++ :paperclip: Uploading artifacts'
         upload_artifacts
 
         # Upload the pipeline.
         Tempfile.create(['pipeline', '.yml']) do |file|
           file.sync = true
-          file.write(pipeline.to_yaml)
+          file.write(to_yaml)
 
           logger.info '+++ :paperclip: Uploading pipeline.yml as artifact'
           Buildkite::Pipelines::Command.artifact!(:upload, file.path)
@@ -62,27 +59,29 @@ module Buildkite
         end
       end
 
-      private
-
-      def load_manifests
-        Loaders::Manifests.load(root).each do |name, asset|
-          Manifest[name] = asset
+      def to_h
+        @pipeline_hash ||= begin
+          results = benchmark("\nDone (%s)".color(:springgreen)) do
+            dsl.instance_eval(&pipeline_definition)
+            extensions.build
+          end
+          logger.info(results)
+          # Build the pipeline definition from pipeline data.
+          Pipelines::Helpers.sanitize(data.to_definition)
         end
       end
 
-      def load_templates
-        Loaders::Templates.load(root).each do |name, asset|
-          pipeline.template(name, &asset)
-        end
+      def to_yaml
+        YAML.dump(to_h)
       end
 
-      def load_processors
-        Loaders::Processors.load(root)
-      end
+      private
+
+      attr_reader :extensions
 
-      def run_processors
-        pipeline.processors.each do |processor|
-          processor.process(self)
+      def load_manifests
+        Loaders::Manifests.load(root).each do |name, asset|
+          Manifest[name] = asset
         end
       end
 
@@ -96,10 +95,6 @@ module Buildkite
         end
       end
 
-      def load_pipeline
-        pipeline.instance_eval(&pipeline_definition)
-      end
-
       def pipeline_definition
         @pipeline_definition ||= load_definition(root.join(PIPELINE_DEFINITION_FILE), Definition::Pipeline)
       end

data/lib/buildkite/builder/plugin_registry.rb

@@ -0,0 +1,27 @@
+module Buildkite
+  module Builder
+    class PluginRegistry
+      def initialize
+        @plugins = {}
+      end
+
+      def add(name, uri, version)
+        name = name.to_s
+
+        if @plugins.key?(name)
+          raise ArgumentError, "Plugin already defined: #{name}"
+        end
+
+        @plugins[name] = [uri, version]
+      end
+
+      def fetch(name)
+        @plugins[name]
+      end
+
+      def to_definition
+        # No-op
+      end
+    end
+  end
+end

data/lib/buildkite/builder/step_collection.rb

@@ -0,0 +1,43 @@
+module Buildkite
+  module Builder
+    class StepCollection
+      attr_reader :templates
+      attr_reader :plugins
+      attr_reader :steps
+
+      def initialize(templates, plugins)
+        @templates = templates
+        @plugins = plugins
+        @steps = []
+      end
+
+      def each(*types)
+        types = types.flatten
+
+        @steps.each do |step|
+          if types.include?(step.class.to_sym)
+            yield step
+          end
+
+          if step.is_a?(Group)
+            step.data.steps.each(*types) do |step|
+              yield step
+            end
+          end
+        end
+      end
+
+      def add(step_class, template = nil, **args, &block)
+        @steps.push(step_class.new(self, template, **args, &block)).last
+      end
+
+      def push(step)
+        @steps.push(step)
+      end
+
+      def to_definition
+        @steps.map(&:to_h)
+      end
+    end
+  end
+end

data/lib/buildkite/builder/template_registry.rb

@@ -0,0 +1,27 @@
+module Buildkite
+  module Builder
+    class TemplateRegistry
+      def initialize(root)
+        @templates = {}
+
+        Loaders::Templates.load(root).each do |name, asset|
+          @templates[name.to_s] = asset
+        end
+      end
+
+      def find(name)
+        return unless name
+
+        unless definition = @templates[name.to_s]
+          raise ArgumentError, "Template not defined: #{name}"
+        end
+
+        definition
+      end
+
+      def to_definition
+        # No-op
+      end
+    end
+  end
+end

data/lib/buildkite/pipelines.rb

@@ -6,7 +6,6 @@ module Buildkite
     autoload :Attributes, File.expand_path('pipelines/attributes', __dir__)
     autoload :Command, File.expand_path('pipelines/command', __dir__)
     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__)

data/lib/buildkite/pipelines/attributes.rb

@@ -84,7 +84,7 @@ module Buildkite
           end
 
           # Define a helper method that is equivalent to `||=` or `Set#add?`. It will
-          # set the attribute iff it hasn't been already set. It will return true/false
+          # set the attribute if it hasn't been already set. It will return true/false
           # for whether or not the value was set.
           define_method("#{method_name}?") do |*args|
             if args.empty?

data/lib/buildkite/pipelines/helpers/command.rb

@@ -8,11 +8,7 @@ module Buildkite
           return super if values.empty?
 
           values.flatten.each do |value|
-            if value == :noop
-              super('true')
-            else
-              super(value)
-            end
+            super(value)
           end
         end
       end

data/lib/buildkite/pipelines/helpers/plugins.rb

@@ -12,7 +12,7 @@ module Buildkite
             raise ArgumentError, "Plugin already used for command step: #{plugin_name}"
           end
 
-          uri, version = pipeline.plugins.fetch(plugin_name)
+          uri, version = step_collection.plugins.fetch(plugin_name)
           new_plugin = Plugin.new(uri, version, options)
           @plugins[plugin_name] = new_plugin
 

data/lib/buildkite/pipelines/step_context.rb

@@ -13,10 +13,6 @@ module Buildkite
         @data = {}
       end
 
-      def pipeline
-        step.pipeline
-      end
-
       def [](key)
         args[key]
       end

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

@@ -1,25 +1,30 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Buildkite
   module Pipelines
     module Steps
       class Abstract
+        extend Forwardable
         include Attributes
 
-        attr_reader :pipeline
+        def_delegator :@context, :data
+
         attr_reader :template
+        attr_reader :step_collection
 
         def self.to_sym
           name.split('::').last.downcase.to_sym
         end
 
-        def initialize(pipeline, template = nil, **args, &block)
-          @pipeline = pipeline
-          @template = template
-          context = StepContext.new(self, **args)
+        def initialize(step_collection, template_name, **args, &block)
+          @step_collection = step_collection
+          @template = step_collection.templates.find(template_name)
+          @context = StepContext.new(self, **args)
 
-          instance_exec(context, &template) if template
-          instance_exec(context, &block) if block_given?
+          instance_exec(@context, &template) if template
+          instance_exec(@context, &block) if block_given?
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorted_set
@@ -133,21 +133,32 @@ 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/data.rb
 - lib/buildkite/builder/definition.rb
+- lib/buildkite/builder/dsl.rb
+- lib/buildkite/builder/extension.rb
+- lib/buildkite/builder/extension_manager.rb
+- lib/buildkite/builder/extensions.rb
+- lib/buildkite/builder/extensions/env.rb
+- lib/buildkite/builder/extensions/notify.rb
+- lib/buildkite/builder/extensions/steps.rb
+- lib/buildkite/builder/extensions/use.rb
 - lib/buildkite/builder/file_resolver.rb
 - lib/buildkite/builder/github.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/manifests.rb
-- lib/buildkite/builder/loaders/processors.rb
 - lib/buildkite/builder/loaders/templates.rb
 - lib/buildkite/builder/logging_utils.rb
 - lib/buildkite/builder/manifest.rb
 - lib/buildkite/builder/manifest/rule.rb
-- lib/buildkite/builder/processors.rb
-- lib/buildkite/builder/processors/abstract.rb
+- lib/buildkite/builder/pipeline.rb
+- lib/buildkite/builder/plugin_registry.rb
 - lib/buildkite/builder/rainbow.rb
+- lib/buildkite/builder/step_collection.rb
+- lib/buildkite/builder/template_registry.rb
 - lib/buildkite/env.rb
 - lib/buildkite/pipelines.rb
 - lib/buildkite/pipelines/api.rb
@@ -164,7 +175,6 @@ files:
 - lib/buildkite/pipelines/helpers/skip.rb
 - lib/buildkite/pipelines/helpers/soft_fail.rb
 - 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
@@ -194,9 +204,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.2
 signing_key:

data/lib/buildkite/builder/processors.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Builder
-    module Processors
-      autoload :Abstract, File.expand_path('processors/abstract', __dir__)
-    end
-  end
-end

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

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Builder
-    module Processors
-      class Abstract
-        include LoggingUtils
-        using Rainbow
-
-        def self.process(context)
-          new(context).run
-        end
-
-        def initialize(context)
-          @context = context
-        end
-
-        def run
-          _log_run { process }
-        end
-
-        private
-
-        attr_reader :context
-
-        def process
-          raise NotImplementedError
-        end
-
-        def log
-          context.logger
-        end
-
-        def pipeline
-          context.pipeline
-        end
-
-        def buildkite
-          @buildkite ||= begin
-            unless Buildkite.env
-              raise 'Must be in Buildkite environment to access the Buildkite API'
-            end
-
-            Buildkite::Pipelines::Api.new(Buildkite.env.api_token)
-          end
-        end
-
-        def pipeline_steps(*types)
-          steps = pipeline.steps
-          types = types.flatten
-          steps = steps.select { |step| types.include?(step.class.to_sym) } if types.any?
-          steps
-        end
-
-        def _log_run
-          log.info "\nProcessing ".color(:dimgray) + self.class.name.color(:springgreen)
-
-          results = benchmark('└──'.color(:springgreen) + ' Finished in %s'.color(:dimgray)) do
-            formatter = log.formatter
-            log.formatter = proc do |_severity, _datetime, _progname, msg|
-              '│'.color(:springgreen) + " #{msg}\n"
-            end
-
-            begin
-              yield
-            ensure
-              log.formatter = formatter
-            end
-          end
-
-          log.info results
-        end
-      end
-    end
-  end
-end

data/lib/buildkite/pipelines/pipeline.rb

@@ -1,140 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'pathname'
-
-module Buildkite
-  module Pipelines
-    class Pipeline
-      attr_reader :steps
-      attr_reader :plugins
-      attr_reader :templates
-
-      def initialize(definition = nil, &block)
-        @env = {}
-        @steps = []
-        @plugins = {}
-        @templates = {}
-        @processors = []
-        @notify = []
-
-        instance_eval(&definition) if definition
-        instance_eval(&block) if block_given?
-      end
-
-      [
-        Steps::Block,
-        Steps::Command,
-        Steps::Input,
-        Steps::Trigger,
-      ].each do |type|
-        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
-
-      def env(*args)
-        if args.empty?
-          @env
-        elsif args.first.is_a?(Hash)
-          @env.merge!(args.first.transform_keys(&:to_s))
-        else
-          raise ArgumentError, 'value must be hash'
-        end
-      end
-
-      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.
-        step.skip(true) if !step.get(:skip) || step.skip.empty?
-        step
-      end
-
-      def wait(attributes = {}, &block)
-        step = add(Steps::Wait, &block)
-        step.wait(nil)
-        attributes.each do |key, value|
-          step.set(key, value)
-        end
-        step
-      end
-
-      def plugin(name, uri, version)
-        name = name.to_s
-
-        if plugins.key?(name)
-          raise ArgumentError, "Plugin already defined: #{name}"
-        end
-
-        @plugins[name] = [uri, version]
-      end
-
-      def template(name, &definition)
-        name = name.to_s
-
-        if templates.key?(name)
-          raise ArgumentError, "Template already defined: #{name}"
-        elsif !block_given?
-          raise ArgumentError, 'Template definition block must be given'
-        end
-
-        @templates[name.to_s] = definition
-      end
-
-      def processors(*processor_classes)
-        unless processor_classes.empty?
-          @processors.clear
-
-          processor_classes.flatten.each do |processor|
-            unless processor < Buildkite::Builder::Processors::Abstract
-              raise "#{processor} must inherit from Buildkite::Builder::Processors::Abstract"
-            end
-
-            @processors << processor
-          end
-        end
-
-        @processors
-      end
-
-      def to_h
-        pipeline = {}
-        pipeline[:env] = env if env.any?
-        pipeline[:notify] = notify if notify.any?
-        pipeline[:steps] = steps.map(&:to_h)
-
-        Helpers.sanitize(pipeline)
-      end
-
-      def to_yaml
-        YAML.dump(to_h)
-      end
-
-      private
-
-      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)
-        return unless name
-
-        templates[name.to_s] || begin
-          raise ArgumentError, "Template not defined: #{name}"
-        end
-      end
-    end
-  end
-end