buildkite-builder 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6eaf580c5dea018a834cf11f76e5d1d1aa13792fda9b9d513993e53f56f0a7
-  data.tar.gz: 5958862296476f8421ccb62fb0f23e7fef86302fdf354b00c8db9885f71691f0
+  metadata.gz: b19e2a9c84be58408585027ddc221dd1b8d6b5f9303085f874a97b460eaf4b7f
+  data.tar.gz: 939afa112be8163360618af03a4d21241b3cdceebef90fee3501052d1258e2cc
 SHA512:
-  metadata.gz: 42719a13b6515e91edd391ea18e3f3e18b8db49ec4e4b36d81d0388a701a7567c63992b72860c20f1041b378c6b7a5475c2f5c33a2e454886c3f8a8a678d0b75
-  data.tar.gz: f19d241a0507f434f778560bb4bf5b10dacbe1f8e743718257ac235b433cffd69f472b4d8eb30f9b3ceb28401cb241bda022743a29ffa8f72449964b3a091fa2
+  metadata.gz: 54cb436ddc5a4d68da270ae84e62af8902d15388d2d44edaf6f9cc0473bec0f7744286a8e8d9ed1ed5a9d15e8c46e23928a70a51c3078bc1426adb1a1a54c685
+  data.tar.gz: f67035e4e34f940c2a5b5c2fae14cda001e8185e20e2aa17db7d38574bf3ddcd5bccf47bd6ccf3a96e6325582a88b52cd8594df4a30f080d3eb712863b51ee6f

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.0.0
+* Remove manifest features to prevent Github API dependency and simplify the gem to focus on Buildkite features.
+
+## 2.4.1
+* Fix pipeline upload as artifact logic.
+
+## 2.4.0
+* Upload custom pipeline artifacts in a single command.
+* Only upload the pipeline as an artifact when the pipeline upload fails.
+
 ## 2.3.0
 * Improve BKB step idempotency.
 

data/VERSION

@@ -1 +1 @@
-2.3.0
+3.0.0

data/lib/buildkite/builder/commands.rb

@@ -5,7 +5,6 @@ module Buildkite
     module Commands
       using Rainbow
       COMMANDS = {
-        'files' => :Files,
         'preview' => :Preview,
         'run' => :Run
       }.freeze

data/lib/buildkite/builder/loaders.rb

@@ -4,7 +4,6 @@ module Buildkite
   module Builder
     module Loaders
       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 :Extensions, File.expand_path('loaders/extensions', __dir__)
     end

data/lib/buildkite/builder/pipeline.rb

@@ -37,7 +37,6 @@ module Buildkite
         use(Extensions::Env)
         use(Extensions::Notify)
         use(Extensions::Steps)
-        load_manifests
       end
 
       def upload
@@ -51,10 +50,12 @@ module Buildkite
           file.sync = true
           file.write(contents)
 
-          logger.info '+++ :paperclip: Uploading pipeline.yml as artifact'
-          Buildkite::Pipelines::Command.artifact!(:upload, file.path)
-          logger.info '+++ :pipeline: Uploading pipeline'
-          Buildkite::Pipelines::Command.pipeline!(:upload, file.path)
+          logger.info "+++ :pipeline: Uploading pipeline"
+          unless Buildkite::Pipelines::Command.pipeline(:upload, file.path)
+            logger.info "Pipeline upload failed, saving as artifact…"
+            Buildkite::Pipelines::Command.artifact!(:upload, file.path)
+            abort
+          end
           logger.info "+++ :toolbox: Setting job meta-data to #{Buildkite.env.job_id.color(:yellow)}"
           Buildkite::Pipelines::Command.meta_data!(:set, Builder::META_DATA.fetch(:job), Buildkite.env.job_id)
         end
@@ -80,22 +81,11 @@ module Buildkite
 
       attr_reader :extensions
 
-      def load_manifests
-        Loaders::Manifests.load(root).each do |name, asset|
-          Manifest[name] = asset
-        end
-      end
-
       def upload_artifacts
         return if artifacts.empty?
 
-        logger.info "+++ :paperclip: Uploading #{artifacts.size.to_s.color(:yellow)} artifact#{'s' if artifacts.size != 1}"
-
-        artifacts.each do |path|
-          if File.exist?(path)
-            Buildkite::Pipelines::Command.artifact!(:upload, path)
-          end
-        end
+        logger.info "+++ :paperclip: Uploading artifacts"
+        Buildkite::Pipelines::Command.artifact!(:upload, artifacts.join(";"))
       end
 
       def pipeline_definition

data/lib/buildkite/builder.rb

@@ -13,11 +13,8 @@ module Buildkite
     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__)
     autoload :LoggingUtils, File.expand_path('builder/logging_utils', __dir__)
-    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 :Plugin, File.expand_path('builder/plugin', __dir__)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ngan Pham
 - Andrew Lee
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -116,7 +116,6 @@ files:
 - lib/buildkite/builder.rb
 - lib/buildkite/builder/commands.rb
 - lib/buildkite/builder/commands/abstract.rb
-- lib/buildkite/builder/commands/files.rb
 - lib/buildkite/builder/commands/preview.rb
 - lib/buildkite/builder/commands/run.rb
 - lib/buildkite/builder/data.rb
@@ -130,17 +129,12 @@ files:
 - 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/templates.rb
 - lib/buildkite/builder/logging_utils.rb
-- lib/buildkite/builder/manifest.rb
-- lib/buildkite/builder/manifest/rule.rb
 - lib/buildkite/builder/pipeline.rb
 - lib/buildkite/builder/plugin.rb
 - lib/buildkite/builder/plugin_collection.rb
@@ -181,7 +175,7 @@ metadata:
   source_code_uri: https://github.com/Gusto/buildkite-builder
   changelog_uri: https://github.com/Gusto/buildkite-builder/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/Gusto/buildkite-builder/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.13
+signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.
 test_files: []

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Builder
-    module Commands
-      class Files < Abstract
-        private
-
-        self.description = 'Outputs files that match the specified manifest.'
-
-        def run
-          manifests = Loaders::Manifests.load(pipeline_path)
-          puts manifests[options[:manifest]].files.sort.join("\n")
-        end
-
-        def parse_options(opts)
-          opts.on('--manifest MANIFEST', 'The manifest to use') do |manifest|
-            options[:manifest] = manifest
-          end
-        end
-      end
-    end
-  end
-end

data/lib/buildkite/builder/file_resolver.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'set'
-
-module Buildkite
-  module Builder
-    class FileResolver
-      @cache = true
-
-      attr_reader :modified_files
-
-      class << self
-        attr_accessor :cache
-
-        def resolve(reset = false)
-          @resolve = nil if !cache || reset
-          @resolve ||= new
-        end
-      end
-
-      def initialize
-        @modified_files = Set.new(pull_request? ? files_from_pull_request.sort! : files_from_git.sort!)
-      end
-
-      private
-
-      def files_from_pull_request
-        Github.pull_request_files.map { |f| f.fetch('filename') }
-      end
-
-      def files_from_git
-        if Buildkite.env
-          changed_files = command("git diff-tree --no-commit-id --name-only -r #{Buildkite.env.commit}")
-        else
-          default_branch = command('git symbolic-ref refs/remotes/origin/HEAD').strip
-          changed_files = command("git diff --name-only #{default_branch}")
-          changed_files << command('git diff --name-only')
-        end
-
-        changed_files.split.uniq.sort
-      end
-
-      def pull_request?
-        Buildkite.env&.pull_request
-      end
-
-      def command(cmd)
-        output, status = Open3.capture2(*cmd.split)
-
-        if status.success?
-          output
-        else
-          raise "Command failed (exit #{status.exitstatus}): #{cmd}"
-        end
-      end
-    end
-  end
-end

data/lib/buildkite/builder/github.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'net/http'
-require 'uri'
-
-module Buildkite
-  module Builder
-    class Github
-      BASE_URI = URI('https://api.github.com').freeze
-      ACCEPT_HEADER = 'application/vnd.github.v3+json'
-      LINK_HEADER = 'link'
-      NEXT_LINK_REGEX = /<(?<uri>.+)>; rel="next"/.freeze
-      REPO_REGEX = /github\.com(?::|\/)(.*?)(?:\.git)?\z/.freeze
-      PER_PAGE = 100
-
-      def self.pull_request_files
-        new.pull_request_files
-      end
-
-      def initialize(env = ENV)
-        @env = env
-      end
-
-      def pull_request_files
-        files = []
-        next_uri = URI.join(BASE_URI, "repos/#{repo}/pulls/#{pull_request_number}/files?per_page=#{PER_PAGE}")
-
-        while next_uri
-          response = request(next_uri)
-          files.concat(JSON.parse(response.body))
-          next_uri = parse_next_uri(response)
-        end
-
-        files
-      end
-
-      private
-
-      def repo
-        Buildkite.env.repo[REPO_REGEX, 1]
-      end
-
-      def token
-        @env.fetch('GITHUB_API_TOKEN')
-      end
-
-      def pull_request_number
-        Buildkite.env.pull_request
-      end
-
-      def request(uri)
-        Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-          request = Net::HTTP::Get.new(uri)
-          request['Authorization'] = "token #{token}"
-          request['Accept'] = ACCEPT_HEADER
-
-          http.request(request)
-        end
-      end
-
-      def parse_next_uri(response)
-        links = response[LINK_HEADER]
-        return unless links
-
-        matches = links.match(NEXT_LINK_REGEX)
-        URI.parse(matches[:uri]) if matches
-      end
-    end
-  end
-end

data/lib/buildkite/builder/loaders/manifests.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Builder
-    module Loaders
-      class Manifests < Abstract
-        MANIFESTS_PATH = Pathname.new('manifests').freeze
-
-        def load
-          return unless manifests_path.directory?
-
-          manifests_path.children.map do |file|
-            add(file.basename, Manifest.new(Buildkite::Builder.root, file.readlines))
-          end
-        end
-
-        def manifests_path
-          root.join(MANIFESTS_PATH)
-        end
-      end
-    end
-  end
-end

data/lib/buildkite/builder/manifest/rule.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-require 'pathname'
-
-module Buildkite
-  module Builder
-    class Manifest::Rule
-      GLOB_OPTIONS = File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_EXTGLOB
-
-      attr_reader :exclude
-      attr_reader :glob
-
-      def initialize(root, pattern)
-        @root = Pathname.new(root)
-        @exclude = false
-        @glob = @root
-
-        if pattern[0] == '!'
-          @exclude = true
-          pattern = pattern[1..-1]
-        end
-
-        if pattern.start_with?('/')
-          pattern = pattern[1..-1]
-        else
-          @glob = @glob.join('**')
-        end
-
-        @glob = @glob.join(pattern).to_s
-      end
-
-      def files
-        @files ||= begin
-          matched = Dir.glob(glob, GLOB_OPTIONS)
-          matched.map! { |file| Pathname.new(file) }
-          matched.reject!(&:directory?)
-          matched.map! { |file| file.relative_path_from(Builder.root) }
-          Set.new(matched.sort!)
-        end
-      end
-
-      def match?(file)
-        file = Pathname.new(file)
-        file = @root.join(file) unless file.absolute?
-
-        File.fnmatch?(glob, file.to_s, GLOB_OPTIONS)
-      end
-    end
-  end
-end

data/lib/buildkite/builder/manifest.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require 'digest/md5'
-require 'pathname'
-
-module Buildkite
-  module Builder
-    class Manifest
-      autoload :Rule, File.expand_path('manifest/rule', __dir__)
-
-      class << self
-        def resolve(root, patterns)
-          new(root, Array(patterns)).modified?
-        end
-
-        def manifests
-          @manifests ||= {}
-        end
-
-        def [](name)
-          manifests[name.to_s]
-        end
-
-        def []=(name, manifest)
-          name = name.to_s
-          if manifests.key?(name)
-            raise ArgumentError, "manifest #{name} already exists"
-          end
-
-          manifests[name] = manifest
-        end
-      end
-
-      attr_reader :root
-
-      def initialize(root, patterns)
-        @root = Pathname.new(root)
-        @root = Buildkite::Builder.root.join(@root) unless @root.absolute?
-        @patterns = patterns.map(&:to_s)
-      end
-
-      def modified?
-        # DO NOT intersect FileResolver with manifest files. If the manifest is
-        # large, the operation can be expensive. It's always cheaper to loop
-        # through the changed files and compare them against the rules.
-        unless defined?(@modified)
-          @modified = FileResolver.resolve.modified_files.any? do |file|
-            file = Buildkite::Builder.root.join(file)
-            inclusion_rules.any? { |rule| rule.match?(file) } &&
-              exclusion_rules.none? { |rule| rule.match?(file) }
-          end
-        end
-
-        @modified
-      end
-
-      def files
-        @files ||= (inclusion_rules.map(&:files).reduce(Set.new, :merge) - exclusion_rules.map(&:files).reduce(Set.new, :merge)).sort.to_set
-      end
-
-      def digest
-        @digest ||= begin
-          digests = files.map { |file| Digest::MD5.file(Buildkite::Builder.root.join(file)).hexdigest }
-          Digest::MD5.hexdigest(digests.join)
-        end
-      end
-
-      private
-
-      def rules
-        @rules ||= @patterns.each_with_object([]) do |pattern, rules|
-          pattern = pattern.strip
-          unless pattern.match?(/\A(#|\z)/)
-            rules << Rule.new(root, pattern)
-          end
-        end
-      end
-
-      def inclusion_rules
-        @inclusion_rules ||= rules.reject(&:exclude)
-      end
-
-      def exclusion_rules
-        @exclusion_rules ||= rules.select(&:exclude)
-      end
-    end
-  end
-end