diffend 0.2.40 → 0.2.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab9ba402e382256b6318f8a4b278ae8e6ae0e68dc9ab15fedca98b8e46f8a105
-  data.tar.gz: 7f0fa88a9af55b5b7d2992fa67fcde7f464f36b68801f4b69b3d0204033428df
+  metadata.gz: cc35a87fc80048201e46cf210e72c4359849b9c17b3208a885e151c2384be274
+  data.tar.gz: c438271e070263543f0cc7ae84911631bc8f57dd4804d2fe58d529caf7929e49
 SHA512:
-  metadata.gz: e41cad9b056aed9f846424964a14862cf5dfeab3596b93673bf7ed9ceacc50beab92157cfe8b98aa4a35c8bce5341862c79e6a35ae03fdc754a85eeb730b7077
-  data.tar.gz: dfd06d10e56962b7ffa3eca0530b8b7fcaa9bb83169c2bd52e672a957de9dba22dd63f2dd91c3d90441c466256446d4609c293e028e75deaa66db28f47fccbfc
+  metadata.gz: 6e41e7343c6c0f1137dab1999ceebc1c8df54c2950e92f68b592d4f2b03c5fc2e5817b9443068423f2ea1508cc78884c169a4551a61e2723bb5c931d6ce05ed4
+  data.tar.gz: 877952bdb836a09034b0e72862cf374a8049a46ee4b416125beaad3a9102b14a1d22878b4128e6efded825d0bc896fcf1873f046f111da9d5ced03907c2d3a1b

data/.github/workflows/ci.yml

@@ -48,6 +48,8 @@ jobs:
         env:
           GITHUB_COVERAGE: ${{matrix.coverage}}
         run: bundle _${{matrix.bundler}}_ exec rspec
+      - name: Run integration tests
+        run: bundle _${{matrix.bundler}}_ exec rake integration_suite
 
   diffend:
     runs-on: ubuntu-latest

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## [Unreleased][master]
+- introduce integration specs ([#107](https://github.com/diffend-io/diffend-ruby/pull/107))
+- use `Bundler::Definition.resolve` for specs ([#112](https://github.com/diffend-io/diffend-ruby/pull/112))
 
 ## [0.2.40] (2021-02-23)
 - don't expose ips, we can identify instance by a hostname ([#108](https://github.com/diffend-io/diffend-ruby/pull/108))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffend (0.2.40)
+    diffend (0.2.41)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+%w[
+  bundler/setup
+].each(&method(:require))
+
+require 'diffend/errors'
+require 'diffend/config'
+require 'diffend/shell'
+require 'diffend/repository'
+require 'diffend/integration_repository'
+
+task :integration_suite do
+  Diffend::Repository::SUPPORTED.each do |command, repositories|
+    repositories.each do |repository_name|
+      repository = Diffend::IntegrationRepository.new(command, repository_name)
+      repository.repository.isolate do |path|
+        start = Time.now.to_f
+
+        repository.config?(path)
+
+        Bundler.with_unbundled_env do
+          repository.install_plugin(path)
+
+          cmd = Diffend::Shell.call_in_path(path, "bundle #{command}")
+
+          unless cmd[:exit_code].zero?
+            puts "#{repository.full_name} FAILED"
+            puts cmd[:stderr]
+            exit 1
+          end
+        end
+
+        took = Time.now.to_f - start
+
+        puts "#{repository.full_name} OK, took #{took.round(1)}s"
+      end
+    end
+  end
+end

data/lib/diffend/errors.rb

@@ -21,5 +21,7 @@ module Diffend
     HandledException = Class.new(BaseError)
     # Raised when we are unable to resolve dependencies
     DependenciesResolveException = Class.new(BaseError)
+    # Failure of a shell command execution
+    FailedShellCommand = Class.new(BaseError)
   end
 end

data/lib/diffend/handle_errors/report.rb

@@ -39,10 +39,10 @@ module Diffend
         # @return [Diffend::RequestObject]
         def build_request_object(config, payload)
           Diffend::RequestObject.new(
-            config: config,
-            url: config.errors_url,
-            payload: payload,
-            request_method: :post
+            config,
+            config.errors_url,
+            payload,
+            :post
           )
         end
 

data/lib/diffend/integration_repository.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Diffend
+  # Repository for integrations
+  class IntegrationRepository
+    # Plugin code entry in Gemfile
+    GEMFILE_PLUGIN_ENTRY = 'plugin \'diffend\''
+    # Gemfile file name
+    GEMFILE_FILE_NAME = 'Gemfile'
+    # Gemfile backup file name
+    GEMFILE_BACKUP_FILE_NAME = 'Gemfile.backup'
+    # Plugin install command
+    PLUGIN_INSTALL_COMMAND = 'bundle plugin install diffend'
+
+    attr_reader :command, :name, :repository
+
+    # @param command [String] command executed via bundler
+    # @param name [String] repository name
+    def initialize(command, name)
+      @command = command
+      @name = name
+      @repository = Diffend::Repository.new(command, name)
+    end
+
+    # @return [String] full name of the repository with command
+    def full_name
+      "#{command}_#{name}"
+    end
+
+    # @param path [String] path to the repository
+    def config?(path)
+      # check if .diffend.yml exists
+      return if File.exist?(File.join(path, Diffend::Config::FILENAME))
+
+      puts "Diffend configuration does not exist for #{command} #{name}"
+      exit 1
+    end
+
+    # @param path [String] path to the repository
+    def install_plugin(path)
+      cmd = Diffend::Shell.call_in_path(path, PLUGIN_INSTALL_COMMAND)
+
+      unless cmd[:exit_code].zero?
+        puts "#{PLUGIN_INSTALL_COMMAND} failed"
+        puts cmd[:stderr]
+        exit 1
+      end
+
+      switch_plugin_to_development(path, cmd[:stdout])
+      add_plugin_to_gemfile(path)
+    end
+
+    private
+
+    # @param path [String] path to the repository
+    # @param stdout [String] stdout from plugin install command
+    def switch_plugin_to_development(path, stdout)
+      installed_version = stdout.scan(/Installing diffend (\d*\.\d*\.\d*)/)[0][0]
+      diffend_working_path = File.expand_path('..', Bundler.bin_path)
+      bundler_plugins_path = File.join(path, '.bundle/plugin/gems')
+      bundler_diffend_plugin_path = File.join(bundler_plugins_path, "diffend-#{installed_version}")
+      FileUtils.mv(bundler_diffend_plugin_path, "#{bundler_diffend_plugin_path}-")
+      FileUtils.ln_s(diffend_working_path, bundler_diffend_plugin_path)
+    end
+
+    # @param path [String] path to the repository
+    def add_plugin_to_gemfile(path)
+      gemfile_path = File.join(path, GEMFILE_FILE_NAME)
+
+      FileUtils.mv(gemfile_path, File.join(path, GEMFILE_BACKUP_FILE_NAME))
+      file = File.open(gemfile_path, 'w')
+      source_detected = nil
+
+      File.readlines(
+        File.join(path, GEMFILE_BACKUP_FILE_NAME)
+      ).each do |line|
+        if line.start_with?('source') && source_detected.nil?
+          source_detected = true
+        elsif source_detected
+          source_detected = false
+          file.write("\n#{GEMFILE_PLUGIN_ENTRY}\n")
+        end
+
+        file.write(line)
+      end
+
+      file.close
+
+      FileUtils.rm(File.join(path, GEMFILE_BACKUP_FILE_NAME))
+    end
+  end
+end

data/lib/diffend/local_context/packages.rb

@@ -71,7 +71,9 @@ module Diffend
       def build_install
         hash = build_main
 
-        @definition.specs.each do |spec|
+        @definition.resolve.each do |spec|
+          # Skip metadata
+          next if spec.instance_variable_get(:@specification).nil?
           next if skip?(spec.source)
 
           locked_spec = @locked_specs.find { |s| s.name == spec.name }
@@ -93,7 +95,9 @@ module Diffend
       def build_update
         hash = build_main
 
-        @definition.specs.each do |spec|
+        @definition.resolve.each do |spec|
+          # Skip metadata
+          next if spec.instance_variable_get(:@specification).nil?
           next if skip?(spec.source)
 
           locked_spec = @locked_specs.find { |s| s.name == spec.name }

data/lib/diffend/plugin.rb

@@ -30,6 +30,9 @@
   request_verdict
   execute
   track
+  shell
+  repository
+  integration_repository
 ].each { |file| require "diffend/#{file}" }
 
 module Diffend

data/lib/diffend/repository.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+%w[
+  tmpdir
+  securerandom
+].each(&method(:require))
+
+module Diffend
+  # Repository for specs
+  class Repository
+    # Repositories path
+    REPOSITORIES_PATH = File.join(
+      File.expand_path('..', Bundler.bin_path),
+      'repositories'
+    ).freeze
+    # List of supported repositories split by command
+    SUPPORTED = {
+      'install' => %w[
+        with_gemfile_lock
+        with_gemfile_lock_with_added_gem
+        with_gemfile_lock_with_changed_gem_version
+        with_gemfile_lock_with_locked_gem_version
+        with_gemfile_lock_with_removed_gem
+        with_gemfile_lock_with_two_platforms
+        with_gemfile_lock_with_two_primary_sources
+        with_gemfile_lock_with_two_sources
+        without_gemfile_lock
+      ].freeze,
+      'update' => %w[
+        with_gemfile_lock
+        with_gemfile_lock_with_added_gem
+        with_gemfile_lock_with_removed_gem
+        with_gemfile_lock_with_two_primary_sources
+        with_gemfile_lock_with_two_sources
+        without_gemfile_lock
+      ].freeze
+    }.freeze
+
+    attr_reader :name, :path
+
+    # @param command [String] command executed via bundler
+    # @param name [String] repository name
+    def initialize(command, name)
+      @command = command
+      @name = name
+      @path = File.join(Dir.tmpdir, SecureRandom.uuid)
+    end
+
+    # Build repository path
+    #
+    # @return [String]
+    def orig_path
+      @orig_path ||= global_file_path(
+        File.join(
+          bundler_version_string,
+          "#{@command}_#{name}"
+        )
+      )
+    end
+
+    # Setup an isolated instance of a repository
+    def setup
+      FileUtils.cp_r(orig_path, path)
+    end
+
+    # Clean isolated instance of a repository
+    def clean
+      FileUtils.rm_rf(path)
+    end
+
+    # Execute tasks in an isolated instance of a repository
+    def isolate
+      setup
+      yield(path)
+      clean
+    end
+
+    # Build the path to a specified file within the repository
+    #
+    # @param file_name [String]
+    #
+    # @return [String]
+    def file_path(file_name)
+      File.join(
+        path,
+        file_name
+      )
+    end
+
+    # Build global path
+    #
+    # @param file_name [String]
+    #
+    # @return [String]
+    def global_file_path(file_name)
+      File.join(
+        REPOSITORIES_PATH,
+        file_name
+      )
+    end
+
+    # Build bundler version string
+    #
+    # @return [String]
+    def bundler_version_string
+      @bundler_version_string ||= "bundler_#{Bundler::VERSION.tr('.', '_')}"
+    end
+  end
+end

data/lib/diffend/request_object.rb

@@ -2,5 +2,5 @@
 
 module Diffend
   # Class responsible for preparing diffend request object
-  RequestObject = Struct.new(:config, :url, :payload, :request_method, keyword_init: true)
+  RequestObject = Struct.new(:config, :url, :payload, :request_method)
 end

data/lib/diffend/request_verdict.rb

@@ -42,10 +42,10 @@ module Diffend
       # @return [Diffend::RequestObject]
       def build_request_object(config, payload)
         Diffend::RequestObject.new(
-          config: config,
-          url: config.commands_url,
-          payload: payload,
-          request_method: :post
+          config,
+          config.commands_url,
+          payload,
+          :post
         )
       end
     end

data/lib/diffend/shell.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+# Helper commands for running Linux shell commands
+module Diffend
+  module Shell
+    class << self
+      # Allows to execute shell commands and handle errors, etc later
+      #   (won't raise any errors but instead will catch all things)
+      # @param command_with_options [String] command that should be executed with
+      #   all the arguments and options
+      # @param raise_on_invalid_exit [Boolean] raise exception when exit code is not 0
+      # @return [Hash] hash with 3 keys describing output
+      #   (stdout, stderr, exit_code)
+      # @example Run ls
+      #   SupportEngine::Shell.('ls') =>
+      #   { stdout: "test.rb\n", stderr: '', exit_code: 0}
+      def call(command_with_options, raise_on_invalid_exit: true)
+        stdout_str, stderr_str, status = Open3.capture3(command_with_options)
+
+        result = {
+          stdout: stdout_str,
+          stderr: stderr_str,
+          exit_code: status.exitstatus
+        }
+
+        raise Diffend::Errors::FailedShellCommand, result.values.join(': ') \
+          if raise_on_invalid_exit && result[:exit_code] != 0
+
+        result
+      end
+
+      # @param path [String, Pathname] to a place where git repo is
+      # @param command [String] that we want to execute in path context
+      # @param raise_on_invalid_exit [Boolean] raise exception when exit code is not 0
+      # @return [Hash] hash with 3 keys describing output (stdout, stderr, exit_code)
+      def call_in_path(path, command, raise_on_invalid_exit: true)
+        command = ['cd', path.to_s, '&&', command]
+        call(command.join(' '), raise_on_invalid_exit: raise_on_invalid_exit)
+      end
+    end
+  end
+end

data/lib/diffend/track.rb

@@ -62,10 +62,10 @@ module Diffend
     # @return [Diffend::RequestObject]
     def build_request_object(request_id)
       Diffend::RequestObject.new(
-        config: @config,
-        url: @config.track_url(request_id),
-        payload: { id: request_id }.freeze,
-        request_method: :put
+        @config,
+        @config.track_url(request_id),
+        { id: request_id }.freeze,
+        :put
       ).freeze
     end
   end

data/lib/diffend/version.rb

@@ -2,5 +2,5 @@
 
 module Diffend
   # Current version
-  VERSION = '0.2.40'
+  VERSION = '0.2.41'
 end