diffend 0.2.36 → 0.2.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c744c4aef5eaa735b131f3f866f9e89d01b9ae79e04cfa1a922419f4be4a3c
-  data.tar.gz: 3ebbd02c2a0b693e57d9b4d7d73c8c9e490236189983a30e7c24caaffb7b5843
+  metadata.gz: 6882244ccac8c68c4b0eef0e1ffceeda710c6202b28a7608e7b6502dc9c8f694
+  data.tar.gz: efd83185b8af53f813204f3265567ed2ed44b6d9e40328d13f613254e3865857
 SHA512:
-  metadata.gz: a166de7306a536d75d20d50c5fe27f27fe77cc4a3332446a85543f42a617b180d3bc97a1a0800c5ada0189eb59d923e8d0a7bd823d3f2f9e31ef2113263a616f
-  data.tar.gz: 5b1890d48842a54166c3eae9d500d43f8c81172f66df9b5f768460fd65e97a2460f542eba99970db8fceb630c97a6fd71f1dd9fe7170c425d5f89b06f448499c
+  metadata.gz: 82509d763d303aad433d329c761d1c36e422314dfb0f55999793829a5c1d1e0a9bdcc4e23a3b4b47dd340fd97129eef567eee23320a5249c0cea956a5fd05468
+  data.tar.gz: bfff54f76c8d02c108c4416756be710991948cd3cebf35143c8ecd98e0a13777a8d445963d2986388db5a480a31094250a2ef9334bd3e58558acdd36bb12e0a7

data/.github/workflows/ci.yml

@@ -8,10 +8,14 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.0'
           - '2.7'
           - '2.6'
           - '2.5'
-          - 'jruby'
+          - 'jruby-9.2.13.0'
+        bundler:
+          - '2.1.4'
+          - '2.2.4'
         include:
           - ruby: '2.7'
             coverage: 'true'
@@ -30,19 +34,17 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{matrix.ruby}}
-      - name: Install latest bundler
-        run: |
-          gem install bundler --no-document
+          bundler: ${{matrix.bundler}}
       - name: Bundle install
         env:
           DIFFEND_DEVELOPMENT: true
         run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundle _${{matrix.bundler}}_ config path vendor/bundle
+          bundle _${{matrix.bundler}}_ install --jobs 4 --retry 3
       - name: Run all tests
         env:
           GITHUB_COVERAGE: ${{matrix.coverage}}
-        run: bundle exec rspec
+        run: bundle _${{matrix.bundler}}_ exec rspec
 
   coditsu:
     runs-on: ubuntu-latest

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.0.0

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [Unreleased][master]
 
+## [0.2.37] (2021-01-05)
+- add support for ENV loaded at runtime ([#92](https://github.com/diffend-io/diffend-ruby/pull/92))
+- allow us to have more control over config errors ([#91](https://github.com/diffend-io/diffend-ruby/pull/91))
+- add `bundle secure` command ([#90](https://github.com/diffend-io/diffend-ruby/pull/90))
+- test against bundler 2.1 and 2.2 ([#83](https://github.com/diffend-io/diffend-ruby/pull/83))
+- test against ruby 3.0.0 ([#89](https://github.com/diffend-io/diffend-ruby/pull/89))
+- simplify how we build full json in specs  ([#82](https://github.com/diffend-io/diffend-ruby/pull/82))
+- simplify how we build bundler json in specs ([#84](https://github.com/diffend-io/diffend-ruby/pull/84))
+- simplify how we build diffend json in specs ([#85](https://github.com/diffend-io/diffend-ruby/pull/85))
+- simplify how we build rubygems json in specs ([#86](https://github.com/diffend-io/diffend-ruby/pull/86))
+- simplify how we build packages platforms json in specs ([#87](https://github.com/diffend-io/diffend-ruby/pull/87))
+
 ## [0.2.36] (2020-12-06)
 - handle `Bundler::PermissionError` ([#79](https://github.com/diffend-io/diffend-ruby/pull/79))
 - use cache to resolve dependencies in exec mode ([#78](https://github.com/diffend-io/diffend-ruby/pull/78))

data/Gemfile

@@ -7,5 +7,6 @@ plugin 'diffend'
 gemspec
 
 group :development, :test do
+  gem 'byebug', platform: :ruby
   gem 'rspec'
 end

data/Gemfile.lock

@@ -1,36 +1,40 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.36)
+    diffend (0.2.37)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.1.3)
     diff-lcs (1.4.4)
-    rake (13.0.1)
+    rake (13.0.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.1)
 
 PLATFORMS
   java
   ruby
+  universal-java-13
+  x86_64-darwin-19
 
 DEPENDENCIES
   bundler
+  byebug
   diffend!
   rake
   rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.4

data/lib/diffend/bundle_secure.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Extend bundler with a new secure command to be able to run Diffend separately
+  class BundleSecure
+    Bundler::Plugin::API.command(Diffend::Commands::SECURE, self)
+
+    # Execute diffend check
+    #
+    # @param _name [String] command name
+    # @param _args [Array] arguments from ARGV
+    def exec(_name, _args)
+      return unless Diffend::Enabled.call
+
+      config = Diffend::Config.new(
+        command: Diffend::Commands::SECURE,
+        severity: Diffend::Logger::INFO
+      )
+
+      Diffend::LatestVersion.call(config)
+
+      Diffend::Execute.call(config)
+    end
+  end
+end

data/lib/diffend/commands.rb

@@ -9,5 +9,7 @@ module Diffend
     UPDATE = 'update'
     # Bundler exec command
     EXEC = 'exec'
+    # Bundler secure command introduced by diffend plugin
+    SECURE = 'secure'
   end
 end

data/lib/diffend/config.rb

@@ -3,29 +3,50 @@
 module Diffend
   # Diffend config object
   class Config
-    attr_reader :project_id, :shareable_id, :shareable_key, :build_path, :env, :command
+    # Name of the diffend config file
+    FILENAME = '.diffend.yml'
+
+    attr_reader :project_id, :shareable_id, :shareable_key, :build_path, :env, :command, :errors
 
     # Build diffend config object
     #
+    # @param command [String] command executed via bundler
+    # @param severity [Integer] logging severity threshold
+    # @param build_path [String] path of the current build
+    #
     # @return [Diffend::Config]
     def initialize(command: nil, severity: nil, build_path: nil)
       @log_level = severity
+      @errors = []
       build(command, build_path)
-      validate
+      Diffend::Configs::Validator.call(self)
     end
 
+    # Initialize logger
     def logger
       @logger ||= Diffend::Logger.new(@log_level)
     end
 
+    # @return [Boolean] true if config is valid, false otherwise
+    def valid?
+      @errors.empty?
+    end
+
+    # @return [Boolean] true if we want to ignore errors, false otherwise
     def ignore_errors?
       @ignore_errors
     end
 
+    # @return [Boolean] true if we are in development mode, false otherwise
     def development?
       @development
     end
 
+    # @return [Boolean] true if we are in deployment mode, false otherwise
+    def deployment?
+      !%w[development test].include?(env)
+    end
+
     # Provides diffend commands endpoint url
     #
     # @return [String]
@@ -51,19 +72,24 @@ module Diffend
       "https://my.diffend.io/api/projects/#{project_id}/bundle/#{request_id}/track"
     end
 
+    # Print config errors
+    def print_errors
+      @errors.each { |error| logger.fatal(error) }
+    end
+
     private
 
+    # @param command [String] command executed via bundler
+    # @param build_path [String] path of the current build
     def build(command, build_path)
       build_path ||= File.expand_path('..', ::Bundler.bin_path)
-      hash = Diffend::Configs::Fetcher.call(logger, plugin_path, build_path)
+      hash = Diffend::Configs::Fetcher.call(plugin_path, build_path)
       hash['build_path'] = build_path
       hash['command'] = command || build_command
 
       hash.each { |key, value| instance_variable_set(:"@#{key}", value) }
-    end
-
-    def validate
-      Diffend::Configs::Validator.call(self)
+    rescue Errors::MalformedConfigurationFile
+      @errors << Diffend::Configs::ErrorMessages.malformed_file
     end
 
     # Command that was run with bundle
@@ -73,6 +99,7 @@ module Diffend
       ARGV.first || ::Bundler.feature_flag.default_cli_command.to_s
     end
 
+    # @return [String] path to the plugin
     def plugin_path
       Pathname.new(File.expand_path('../..', __dir__))
     end

data/lib/diffend/configs/error_messages.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Module for all the components related to setting up the config
+  module Configs
+    # Class responsible for config error messages
+    module ErrorMessages
+      class << self
+        # @return [String] malformed configuration file message
+        def malformed_file
+          'Your Diffend configuration file is malformed. Please re-setup.'
+        end
+
+        # Missing key message
+        #
+        # @param key [String] missing key
+        #
+        # @return [String]
+        def missing_key(key)
+          "Diffend configuration is missing #{key} key"
+        end
+
+        # Invalid key message
+        #
+        # @param config [Diffend::Config]
+        # @param key [String] invalid key
+        #
+        # @return [String]
+        def invalid_key(config, key)
+          <<~MSG
+            Diffend configuration value for #{key} is invalid.
+            Expected #{Validator::KNOWN_KEYS[key].join(' or ')}, was #{config.public_send(key).class}.
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/diffend/configs/fetcher.rb

@@ -11,7 +11,6 @@ module Diffend
     # Class responsible for fetching the config from .diffend.yml
     module Fetcher
       class << self
-        # @param logger [Diffend::Logger]
         # @param plugin_path [String] path of the plugin
         # @param build_path [String] path of the current build
         #
@@ -20,24 +19,9 @@ module Diffend
         # @example
         #   details = Fetcher.new.call('./')
         #   details.build_path #=> './'
-        def call(logger, plugin_path, build_path)
-          build(plugin_path, build_path)
-        rescue Errors::MalformedConfigurationFile
-          build_malformed_error_message(build_path)
-            .tap(&logger.method(:fatal))
-
-          raise Diffend::Errors::HandledException
-        end
-
-        private
-
-        # @param plugin_path [String] path of the plugin
-        # @param build_path [String] path of the current build
-        #
-        # @return [OpenStruct] open struct with config details
-        def build(plugin_path, build_path)
+        def call(plugin_path, build_path)
           default_config = File.join(plugin_path, 'config', 'diffend.yml')
-          project_config = File.join(build_path, '.diffend.yml')
+          project_config = File.join(build_path, Diffend::Config::FILENAME)
 
           hash = read_file(default_config)
 
@@ -48,19 +32,18 @@ module Diffend
           hash
         end
 
-        def read_file(path)
-          YAML.safe_load(ERB.new(File.read(path)).result)
+        private
+
+        # Load config file
+        #
+        # @param file_path [String]
+        #
+        # @return [Hash]
+        def read_file(file_path)
+          YAML.safe_load(ERB.new(File.read(file_path)).result)
         rescue Psych::SyntaxError
           raise Errors::MalformedConfigurationFile
         end
-
-        # @return [String] malformed configuration file message
-        def build_malformed_error_message
-          <<~MSG
-            \nYour Diffend configuration file is malformed.\n
-            Please re-setup.\n
-          MSG
-        end
       end
     end
   end

data/lib/diffend/configs/validator.rb

@@ -5,6 +5,7 @@ module Diffend
   module Configs
     # Class responsible for validating the config from .diffend.yml
     module Validator
+      # List of known config keys
       KNOWN_KEYS = {
         project_id: [String],
         shareable_id: [String],
@@ -21,18 +22,11 @@ module Diffend
         def call(config)
           KNOWN_KEYS.each_key do |key|
             if missing?(config, key)
-              missing_key_message(key)
-                .tap(&config.logger.method(:fatal))
-
-              raise Diffend::Errors::HandledException
+              config.errors << ErrorMessages.missing_key(key)
+              next
             end
 
-            if invalid?(config, key)
-              invalid_key_message(config, key)
-                .tap(&config.logger.method(:fatal))
-
-              raise Diffend::Errors::HandledException
-            end
+            config.errors << ErrorMessages.invalid_key(config, key) if invalid?(config, key)
           end
         end
 
@@ -55,30 +49,6 @@ module Diffend
         def invalid?(config, key)
           !KNOWN_KEYS[key].include?(config.public_send(key).class)
         end
-
-        # Missing key message
-        #
-        # @param key [String] missing key
-        #
-        # @return [String]
-        def missing_key_message(key)
-          <<~MSG
-            \nDiffend configuration is missing #{key} key.\n
-          MSG
-        end
-
-        # Invalid key message
-        #
-        # @param hash [Hash] config hash
-        # @param key [String] invalid key
-        #
-        # @return [String]
-        def invalid_key_message(hash, key)
-          <<~MSG
-            \nDiffend configuration value for #{key} is invalid.\n
-            It should be #{KNOWN_KEYS[key].join(' or ')} but is #{hash.public_send(key).class}.\n
-          MSG
-        end
       end
     end
   end

data/lib/diffend/enabled.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Verify if the plugin is enabled
+  module Enabled
+    class << self
+      # Checks if plugin is enabled
+      #
+      # @return [Boolean] true if enabled, false otherwise
+      def call
+        ::Bundler
+          .default_gemfile
+          .read
+          .split("\n")
+          .reject(&:empty?)
+          .map(&:strip)
+          .select { |line| line.start_with?('plugin') }
+          .any? { |line| line.include?('diffend') }
+      end
+    end
+  end
+end

data/lib/diffend/local_context/packages.rb

@@ -39,7 +39,7 @@ module Diffend
           Bundler.ui.silence { instance.resolve }
 
           case command
-          when Commands::INSTALL, Commands::EXEC then instance.build_install
+          when Commands::INSTALL, Commands::EXEC, Commands::SECURE then instance.build_install
           when Commands::UPDATE then instance.build_update
           else
             raise ArgumentError, "invalid command: #{command}"

data/lib/diffend/logger.rb

@@ -3,17 +3,17 @@
 module Diffend
   # Diffend logging
   class Logger
-    # Low-level information, mostly for developers.
+    # Low-level information, mostly for developers
     DEBUG = 0
-    # Generic (useful) information about system operation.
+    # Generic (useful) information about system operation
     INFO = 1
-    # A warning.
+    # A warning
     WARN = 2
-    # A handleable error condition.
+    # A handleable error condition
     ERROR = 3
-    # An unhandleable error that results in a program crash.
+    # An error that we are unable to handle that results in a program crash
     FATAL = 4
-    # An unknown message that should always be logged.
+    # An unknown message that should always be logged
     UNKNOWN = 5
 
     # @param level [Integer] logging severity threshold

data/lib/diffend/monitor.rb

@@ -6,6 +6,7 @@
   errors
   build_bundler_definition
   commands
+  configs/error_messages
   config
   configs/fetcher
   configs/validator
@@ -25,19 +26,28 @@
   track
 ].each { |file| require "diffend/#{file}" }
 
-begin
-  config = Diffend::Config.new(
-    command: Diffend::Commands::EXEC,
-    severity: Diffend::Logger::FATAL
-  )
-rescue Diffend::Errors::HandledException
-  # we silent exit here because we don't want to break client boot
-  return
-end
+Thread.new do
+  config = nil
+  config_iterations = 0
 
-return if %w[development test].include?(config.env)
+  loop do
+    config = Diffend::Config.new(
+      command: Diffend::Commands::EXEC,
+      severity: Diffend::Logger::FATAL
+    )
+
+    break if config.valid?
+
+    config_iterations += 1
+
+    break if config_iterations == 12
+
+    sleep 5
+  end
+
+  Thread.exit unless config.valid?
+  Thread.exit unless config.deployment?
 
-Thread.new do
   track = Diffend::Track.new(config)
   track.start
 end

data/lib/diffend/plugin.rb

@@ -7,10 +7,12 @@
 %w[
   version
   logger
+  enabled
   latest_version
   errors
   build_bundler_definition
   commands
+  configs/error_messages
   config
   configs/fetcher
   configs/validator
@@ -42,10 +44,16 @@ module Diffend
 
       # Execute diffend plugin
       def execute
-        return unless enabled?
+        return unless Diffend::Enabled.call
 
         config = Diffend::Config.new(severity: Diffend::Logger::INFO)
 
+        unless config.valid?
+          config.print_errors
+
+          exit 255
+        end
+
         Diffend::LatestVersion.call(config)
 
         Diffend::Execute.call(config)
@@ -67,20 +75,6 @@ module Diffend
 
         exit 255
       end
-
-      # Checks if plugin is enabled
-      #
-      # @return [Boolean] true if enabled, false otherwise
-      def enabled?
-        ::Bundler
-          .default_gemfile
-          .read
-          .split("\n")
-          .reject(&:empty?)
-          .map(&:strip)
-          .select { |line| line.start_with?('plugin') }
-          .any? { |line| line.include?('diffend') }
-      end
     end
   end
 end

data/lib/diffend/version.rb

@@ -2,5 +2,5 @@
 
 module Diffend
   # Current version
-  VERSION = '0.2.36'
+  VERSION = '0.2.37'
 end

data/plugins.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 require 'diffend/plugin'
+require 'diffend/bundle_secure'
 
 Diffend::Plugin.register

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend
 version: !ruby/object:Gem::Version
-  version: 0.2.36
+  version: 0.2.37
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,10 +94,13 @@ files:
 - diffend.gemspec
 - lib/diffend.rb
 - lib/diffend/build_bundler_definition.rb
+- lib/diffend/bundle_secure.rb
 - lib/diffend/commands.rb
 - lib/diffend/config.rb
+- lib/diffend/configs/error_messages.rb
 - lib/diffend/configs/fetcher.rb
 - lib/diffend/configs/validator.rb
+- lib/diffend/enabled.rb
 - lib/diffend/errors.rb
 - lib/diffend/execute.rb
 - lib/diffend/handle_errors/build_exception_payload.rb
@@ -139,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: OSS supply chain security and management platform