diffend-monitor 0.2.32 → 0.2.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c768b418104d68684a82f952185990ed2dcd7a339fd72b7b3866df6b6806ba4
-  data.tar.gz: 0eb8f311d59b5551e6dfef8c5119b10f91e3a96aee4574341120cc92ae5e9319
+  metadata.gz: ba1c9bb7665b8c21fd45c17d75edf757fa23a07170d62182c12630705a465dc9
+  data.tar.gz: ac0e9d69574c6b1fc7302ebada67570975f16e32c85c4f35caa5f2c11fa303d4
 SHA512:
-  metadata.gz: ce06b1df8da8642628a0b78669d1a112d0215807ff5dde7a2a6164391214a48b5401e1eae676fa02e92c1b5d70733fb5c7c5930c365488cc1996c43e33afc3b3
-  data.tar.gz: 886a3dd46a6040a70a9c0e1e7966f4e27e7586aff576d4e4d5808b076885235625e3ea0fab94ecaf9969cbce414c45069884ad96dfad171ca6d50f9eea89be1f
+  metadata.gz: a2ab62a44ab9d8be96fd37eccb1af6d015645c34c2953c56f2481f3d91a49ea88df88962250554600a64d3e3b73140905c8fda755e8dbc66850c4d4b958a5206
+  data.tar.gz: 86b2f1c7f0bb5b2fb23a2c590574f087bdc621fa13e59da09bdf4033218322c501df2f77e773a158939be7e9bda1cf114b78e5315cbfe0edb65b398e6d21d59f

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased][master]
 
+## [0.2.33] (2020-10-25)
+- fix an exception when configuration file is missing ([#65](https://github.com/diffend-io/diffend-ruby/pull/65))
+- silently exit when configuration file is missing in `Diffend::Monitor` ([#66](https://github.com/diffend-io/diffend-ruby/pull/66))
+- introduce default config ([#67](https://github.com/diffend-io/diffend-ruby/pull/67))
+- handle `SocketError` ([#68](https://github.com/diffend-io/diffend-ruby/pull/68))
+
 ## [0.2.32] (2020-10-02)
 - fix how we build platform from `Gem::Platform` ([#56](https://github.com/diffend-io/diffend-ruby/pull/56))
 - introduce `Diffend::LatestVersion` ([#57](https://github.com/diffend-io/diffend-ruby/pull/57))
@@ -85,7 +91,10 @@
 
 - initial release
 
-[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.30...HEAD
+[master]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.33...HEAD
+[0.2.33]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.32...v0.2.33
+[0.2.32]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.31...v0.2.32
+[0.2.31]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.30...v0.2.31
 [0.2.30]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.29...v0.2.30
 [0.2.29]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.28...v0.2.29
 [0.2.28]: https://github.com/diffend-io/diffend-ruby/compare/v0.2.27...v0.2.28

data/Gemfile

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

data/Gemfile.lock

@@ -1,26 +1,18 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.32)
+    diffend (0.2.33)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.13.1-java)
-    method_source (1.0.0)
-    pry (0.13.1-java)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      spoon (~> 0.0)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
+    rspec-core (3.9.3)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -29,8 +21,6 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    spoon (0.0.6)
-      ffi
 
 PLATFORMS
   java
@@ -38,9 +28,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  byebug
   diffend!
-  pry
   rake
   rspec
 

data/config/diffend.yml

@@ -0,0 +1,6 @@
+project_id: <%= ENV['DIFFEND_PROJECT_ID'] %>
+shareable_id: <%= ENV['DIFFEND_SHAREABLE_ID'] %>
+shareable_key: <%= ENV['DIFFEND_SHAREABLE_KEY'] %>
+env: <%= ENV['DIFFEND_ENV'] || 'development' %>
+ignore_errors: <%= ENV['DIFFEND_IGNORE_ERRORS'] || 'true' %>
+development: <%= ENV['DIFFEND_DEVELOPMENT'] || 'true' %>

data/lib/diffend/config.rb

@@ -8,8 +8,6 @@ module Diffend
     # Build diffend config object
     #
     # @return [Diffend::Config]
-    #
-    # @raise [Errors::MissingConfigurationFile] when no config file
     def initialize(command: nil, severity: nil, build_path: nil)
       @log_level = severity
       build(command, build_path)
@@ -57,11 +55,8 @@ module Diffend
 
     def build(command, build_path)
       build_path ||= File.expand_path('..', ::Bundler.bin_path)
-      hash = Diffend::Configs::Fetcher.call(logger, build_path)
+      hash = Diffend::Configs::Fetcher.call(logger, plugin_path, build_path)
       hash['build_path'] = build_path
-      hash['env'] = ENV['DIFFEND_ENV'] || 'development'
-      hash['ignore_errors'] = ENV['DIFFEND_IGNORE_ERRORS'] == 'true'
-      hash['development'] = ENV['DIFFEND_DEVELOPMENT'] == 'true'
       hash['command'] = command || build_command
 
       hash.each { |key, value| instance_variable_set(:"@#{key}", value) }
@@ -77,5 +72,9 @@ module Diffend
     def build_command
       ARGV.first || ::Bundler.feature_flag.default_cli_command.to_s
     end
+
+    def plugin_path
+      Pathname.new(File.expand_path('../..', __dir__))
+    end
   end
 end

data/lib/diffend/configs/fetcher.rb

@@ -9,6 +9,7 @@ module Diffend
     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
         #
         # @return [Hash] details from configuration file
@@ -16,18 +17,8 @@ module Diffend
         # @example
         #   details = Fetcher.new.call('./')
         #   details.build_path #=> './'
-        def call(logger, build_path)
-          build(build_path)
-        rescue Errors::MissingConfigurationFile
-          build_missing_error_message(build_path)
-            .tap(&logger.method(:fatal))
-
-          raise Diffend::Errors::HandledException
-        rescue Errors::EmptyConfigurationFile
-          build_empty_error_message(build_path)
-            .tap(&logger.method(:fatal))
-
-          raise Diffend::Errors::HandledException
+        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))
@@ -37,45 +28,29 @@ module Diffend
 
         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(build_path)
-          content = ERB.new(
-            File.read(
-              FileFinder.call(build_path)
-            )
-          ).result
+        def build(plugin_path, build_path)
+          default_config = File.join(plugin_path, 'config', 'diffend.yml')
+          project_config = File.join(build_path, '.diffend.yml')
+
+          hash = read_file(default_config)
 
-          raise Errors::EmptyConfigurationFile if content.empty?
+          if File.exist?(project_config)
+            hash.merge!(read_file(project_config) || {})
+          end
 
-          parse_file(content)
+          hash
         end
 
-        def parse_file(content)
-          YAML.safe_load(content)
+        def read_file(path)
+          YAML.safe_load(ERB.new(File.read(path)).result)
         rescue Psych::SyntaxError
           raise Errors::MalformedConfigurationFile
         end
 
-        # @param build_path [String] path of the current build
-        #
-        # @return [String] missing configuration file message
-        def build_missing_error_message(build_path)
-          <<~MSG
-            \nWe were unable to locate Diffend configuration file.\n
-            Please make sure that .diffend.yml is present in #{build_path} folder.\n
-          MSG
-        end
-
-        # @return [String] empty configuration file message
-        def build_empty_error_message
-          <<~MSG
-            \nYour Diffend configuration file is empty.\n
-            Please re-setup.\n
-          MSG
-        end
-
         # @return [String] malformed configuration file message
         def build_malformed_error_message
           <<~MSG

data/lib/diffend/errors.rb

@@ -5,10 +5,6 @@ module Diffend
   module Errors
     # Base error class from which all the errors should inherit
     BaseError = Class.new(StandardError)
-    # Raised when we couldn't find a valid configuration file
-    MissingConfigurationFile = Class.new(BaseError)
-    # Raised when configuration file is empty
-    EmptyConfigurationFile = Class.new(BaseError)
     # Raised when configuration file is malformed
     MalformedConfigurationFile = Class.new(BaseError)
     # Raised when project_id is missing in configuration file

data/lib/diffend/monitor.rb

@@ -8,7 +8,6 @@
   commands
   config
   configs/fetcher
-  configs/file_finder
   configs/validator
   handle_errors/messages
   handle_errors/build_exception_payload
@@ -26,10 +25,15 @@
   track
 ].each { |file| require "diffend/#{file}" }
 
-config = Diffend::Config.new(
-  command: Diffend::Commands::EXEC,
-  severity: Diffend::Logger::FATAL
-)
+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
 
 return if %w[development test].include?(config.env)
 

data/lib/diffend/plugin.rb

@@ -13,7 +13,6 @@
   commands
   config
   configs/fetcher
-  configs/file_finder
   configs/validator
   handle_errors/messages
   handle_errors/build_exception_payload
@@ -51,7 +50,8 @@ module Diffend
 
         Diffend::Execute.call(config)
       rescue Diffend::Errors::HandledException
-        return if config.ignore_errors?
+        # config will not be initialized when configuration file is missing
+        return if config&.ignore_errors?
 
         exit 255
       rescue StandardError => e

data/lib/diffend/request.rb

@@ -14,7 +14,8 @@ module Diffend
       Errno::ECONNRESET,
       Errno::ENETUNREACH,
       Errno::EHOSTUNREACH,
-      Errno::ECONNREFUSED
+      Errno::ECONNREFUSED,
+      SocketError
     ].freeze
     # Message displayed when timeout occured and we will retry
     TIMEOUT_MESSAGE = 'We experienced a connection issue, retrying...'

data/lib/diffend/version.rb

@@ -2,5 +2,5 @@
 
 module Diffend
   # Current version
-  VERSION = '0.2.32'
+  VERSION = '0.2.33'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffend-monitor
 version: !ruby/object:Gem::Version
-  version: 0.2.32
+  version: 0.2.33
 platform: ruby
 authors:
 - Tomasz Pajor
@@ -34,7 +34,7 @@ cert_chain:
   9MmF6uCQa1EjK2p8tYT0MnbHrFkoehxdX4VO9y99GAkhZyJNKPYPtyAUFV27sT2V
   LfCJRk4ifKIN/FUCwDSn8Cz0m6oH265q0p6wdzI6qrWOjP8tGOMBTA==
   -----END CERTIFICATE-----
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,13 +90,13 @@ files:
 - bin/rspec
 - certs/mensfeld.pem
 - certs/tomaszpajor.pem
+- config/diffend.yml
 - diffend.gemspec
 - lib/diffend.rb
 - lib/diffend/build_bundler_definition.rb
 - lib/diffend/commands.rb
 - lib/diffend/config.rb
 - lib/diffend/configs/fetcher.rb
-- lib/diffend/configs/file_finder.rb
 - lib/diffend/configs/validator.rb
 - lib/diffend/errors.rb
 - lib/diffend/execute.rb
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: OSS supply chain security and management platform

data/lib/diffend/configs/file_finder.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Diffend
-  module Configs
-    # Class used to figure out the file from which we should load the settings
-    module FileFinder
-      # Names of the files or paths where we will look for the settings
-      #
-      # @note We do the double dot trick, to look outside of the current dir because when
-      #   executed from a docker container, we copy the local uncommitted settings into the
-      #   dir above the app location not to pollute the reset state of the git repo
-      #
-      # @note Order is important, as for local env we should load from
-      #   local file (if present first)
-      FILE_NAMES = %w[
-        .diffend.yml
-      ].map { |name| ["../#{name}", name] }.tap(&:flatten!).freeze
-
-      private_constant :FILE_NAMES
-
-      class << self
-        # Looks for Diffend settings file for a given env
-        #
-        # @param build_path [String] path of the current build
-        #
-        # @return [String] path to the file from which we should load all the settings
-        def call(build_path)
-          FILE_NAMES
-            .map { |name| File.join(build_path, name) }
-            .map { |name| Dir[name] }
-            .find { |selection| !selection.empty? }
-            .tap { |path| path || raise(Errors::MissingConfigurationFile) }
-            .first
-        end
-      end
-    end
-  end
-end