dragnet 5.2.1

data/lib/dragnet/verifiers/repos_verifier.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative '../errors/not_a_repository_error'
+require_relative '../test_record'
+require_relative 'changes_verifier'
+require_relative 'files_verifier'
+require_relative 'verifier'
+
+module Dragnet
+  module Verifiers
+    # Verifies the +Repo+ objects attached to a +TestRecord+
+    class ReposVerifier < Dragnet::Verifiers::Verifier
+      attr_reader :multi_repository
+
+      # @param [Dragnet::TestRecord] test_record The +TestRecord+ object to
+      #   verify.
+      # @param [Dragnet::MultiRepository] multi_repository The +MultiRepository+
+      #   object that is supposed to contain the actual repositories inside.
+      def initialize(test_record:, multi_repository:)
+        super(test_record: test_record)
+        @multi_repository = multi_repository
+      end
+
+      # Carries out the verification of the +Repo+ objects.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   when the verification of any of the listed repositories fails and
+      #   +nil+ when all of them pass the verification.
+      def verify
+        return unless test_record.repos&.any?
+
+        test_record.repos.each do |repo|
+          repository = fetch_repository(repo.path, multi_repository)
+          verification_result = verify_repo(repo, repository)
+
+          return verification_result if verification_result
+        end
+      rescue Dragnet::Errors::NotARepositoryError => e
+        Dragnet::VerificationResult.new(status: :failed, reason: e.message)
+      end
+
+      private
+
+      # Verifies the given +Repo+ object using the given +Dragnet::Repository+
+      # object and a Proxy TestRecord object.
+      # @param [Dragnet::Repo] repo +Repo+ the +Repo+ object to verify.
+      # @param [Dragnet::Repository] repository The +Repository+ object that
+      #   actually contains the source the +Repo+ object is referring to.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   when the verification fails or +nil+ when the verification passes.
+      def verify_repo(repo, repository)
+        # The Proxy TestRecord object allows the use of the +FilesVerifier+ and
+        # the +ChangesVerifier+ since they expect a +TestRecord+ and not a
+        # +Repo+ object.
+        proxy_test_record = Dragnet::TestRecord.new(files: repo.files, sha1: repo.sha1)
+
+        if repo.files
+          Dragnet::Verifiers::FilesVerifier
+            .new(test_record: proxy_test_record, repository: repository).verify
+        else
+          Dragnet::Verifiers::ChangesVerifier
+            .new(test_record: proxy_test_record, repository: repository, test_records: []).verify
+        end
+      end
+
+      # Fetches the +Repository+ object associated with the given path from the
+      # given +MultiRepository+ object.
+      # @param [Pathname] path The path of the repository.
+      # @param [Dragnet::MultiRepository] multi_repository The +MultiRepository+
+      #   object that contains the repository to be fetched.
+      # @return [Dragnet::Repository] The +Repository+ object associated with
+      #   the given path.
+      def fetch_repository(path, multi_repository)
+        multi_repository.repositories[path] ||= create_repository(multi_repository, path)
+      end
+
+      # Creates a new repository with the given path.
+      # @param [Dragnet::MultiRepository] multi_repository The +MultiRepository+
+      #   object in which the individual repository should be created.
+      # @param [Pathname] path The path for the +Repository+ object.
+      # @return [Dragnet::Repository] The resulting +Repository+ object.
+      # @raise [Dragnet::Errors::NotARepositoryError] If the given path doesn't
+      #   lead to a valid git repository or the repository cannot be opened.
+      def create_repository(multi_repository, path)
+        repository_path = multi_repository.path / path
+        Dragnet::Repository.new(path: repository_path)
+      rescue ArgumentError
+        raise Dragnet::Errors::NotARepositoryError,
+              "The path '#{path}' does not contain a valid git repository."
+      end
+    end
+  end
+end

data/lib/dragnet/verifiers/repository_verifier.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'verifier'
+
+module Dragnet
+  module Verifiers
+    # Base class for the Verifiers that need access to the repository to perform
+    # the validation.
+    class RepositoryVerifier < Dragnet::Verifiers::Verifier
+      attr_reader :repository
+
+      # @param [Dragnet::Repository] repository A +Dragnet::Repository+ object
+      #   linked to the repository where the sources and MTR files are located
+      def initialize(test_record:, repository:)
+        super(test_record: test_record)
+        @repository = repository
+      end
+
+      private
+
+      # @return [String] The path to the repository.
+      def path
+        @path ||= repository.path
+      end
+    end
+  end
+end

data/lib/dragnet/verifiers/result_verifier.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'verifier'
+require_relative '../verification_result'
+
+module Dragnet
+  module Verifiers
+    # Verifies the +result+ field on the given MTR record.
+    class ResultVerifier < Dragnet::Verifiers::Verifier
+      # Performs the verification. If the +result+ field contains the "failed"
+      # text then a +result+ key will be added to the Test Record explaining
+      # the reason for the failure.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   when the verification fails and +nil+ when the verification passes.
+      def verify
+        return if test_record.passed?
+
+        Dragnet::VerificationResult.new(
+          status: :failed,
+          reason: "'result' field has the status '#{result}'"
+        )
+      end
+
+      private
+
+      # @return [String] The value for the +result+ key on the MTR file.
+      def result
+        @result ||= test_record.result
+      end
+    end
+  end
+end

data/lib/dragnet/verifiers/test_record_verifier.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'changes_verifier'
+require_relative 'files_verifier'
+require_relative 'repos_verifier'
+require_relative 'result_verifier'
+require_relative 'verifier'
+
+module Dragnet
+  module Verifiers
+    # Performs the verification process over a single TestRecord object.
+    class TestRecordVerifier < Dragnet::Verifiers::Verifier
+      attr_reader :repository, :test_records
+
+      # @param [Dragnet::TestRecord] test_record The +TestRecord+ object to
+      #   verify.
+      # @param [Dragnet::BaseRepository] repository An object representing the
+      #   repository the test record is referring to.
+      # @param [Array<Dragnet::TestRecord>] test_records An array with all the
+      #   +TestRecord+ objects found in the +Repository+. These are needed when
+      #   changes to the repository are being verified. Changes targeting the
+      #   MTRs only are ignored by the verifiers.
+      def initialize(test_record:, repository:, test_records:)
+        super(test_record: test_record)
+        @repository = repository
+        @test_records = test_records
+      end
+
+      # Performs the verification and attaches the corresponding
+      # +VerificationResult+ object to the +TestRecord+ object.
+      # @return [Dragnet::VerificationResult] The result of the verification
+      #   process executed over the given +test_record+.
+      def verify
+        verification_result = verify_result
+
+        verification_result ||= if test_record.files
+                                  verify_files
+                                elsif test_record.repos
+                                  verify_repos
+                                else
+                                  verify_changes
+                                end
+
+        verification_result || Dragnet::VerificationResult.new(status: :passed)
+      end
+
+      private
+
+      # Verifies the MTR's +result+ attribute.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   when the verification fails and +nil+ when the verification passes.
+      def verify_result
+        Dragnet::Verifiers::ResultVerifier.new(test_record: test_record).verify
+      end
+
+      # Verifies the files listed in the MTR, if any.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   with the detected changes to the listed files or +nil+ if no changes
+      #   are found.
+      def verify_files
+        Dragnet::Verifiers::FilesVerifier
+          .new(test_record: test_record, repository: repository).verify
+      end
+
+      # Verifies the repositories listed in the MTR, only applies when working
+      #   with a {Dragnet::MultiRepository} repository.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ object
+      #   when the verification of any of the listed repositories fails and
+      #   +nil+ when all of them pass the verification.
+      def verify_repos
+        Dragnet::Verifiers::ReposVerifier.new(test_record: test_record, multi_repository: repository).verify
+      end
+
+      # Verifies the changes in the repository between the revision referenced
+      # in the MTR and the tip of the current branch.
+      # @return [Dragnet::VerificationResult, nil] A +VerificationResult+ with
+      #   the details of the changes found in the repository or +nil+ if no
+      #   changes were found.
+      def verify_changes
+        Dragnet::Verifiers::ChangesVerifier
+          .new(test_record: test_record, repository: repository, test_records: test_records).verify
+      end
+    end
+  end
+end

data/lib/dragnet/verifiers/verifier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/repository_helper'
+
+module Dragnet
+  module Verifiers
+    # Base class for all validators.
+    class Verifier
+      include Dragnet::Helpers::RepositoryHelper
+
+      attr_reader :test_record
+
+      # Creates a new instance of the class.
+      # @param [Dragnet::TestRecord] test_record The +TestRecord+ object to
+      #   verify.
+      def initialize(test_record:)
+        @test_record = test_record
+      end
+
+      # Needs to be implemented by the child classes. This method is called to
+      # perform the verification on the given +test_record+.
+      # @return [Dragnet::VerificationResult, nil] The method should return a
+      #   +VerificationResult+ object if the verification fails or +nil+ if it
+      #   passes.
+      def verify
+        raise NotImplementedError, "Please implement #{__method__} in #{self.class}"
+      end
+
+      private
+
+      # @return [String] The SHA1 stored in the MTR File.
+      def sha1
+        @sha1 ||= test_record.sha1
+      end
+    end
+  end
+end

data/lib/dragnet/verifiers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'verifiers/repos_verifier'
+
+module Dragnet
+  # Namespace for the Verifier classes.
+  module Verifiers; end
+end

data/lib/dragnet/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dragnet
+  VERSION = '5.2.1'
+end

data/lib/dragnet.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dragnet/version'
+
+require_relative 'dragnet/cli'
+require_relative 'dragnet/errors'
+require_relative 'dragnet/explorer'
+require_relative 'dragnet/exporter'
+require_relative 'dragnet/exporters'
+require_relative 'dragnet/multi_repository'
+require_relative 'dragnet/repo'
+require_relative 'dragnet/validator'
+require_relative 'dragnet/validators'
+require_relative 'dragnet/verifiers'
+
+# Main namespace for the gem
+module Dragnet
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: dragnet
+version: !ruby/object:Gem::Version
+  version: 5.2.1
+platform: ruby
+authors:
+- ESR Labs GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Provides a command line tool to perform different types of validations
+  on MTR files. These files are YAML files that contain information about the performed
+  test and the revision (commit) for which the test was performed.
+email:
+- info@esrlabs.com
+executables:
+- dragnet
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".github/workflows/ruby-linters.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".github/workflows/sphinx-doc.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- default.reek
+- dragnet.gemspec
+- exe/dragnet
+- lib/dragnet.rb
+- lib/dragnet/base_repository.rb
+- lib/dragnet/cli.rb
+- lib/dragnet/cli/base.rb
+- lib/dragnet/cli/logger.rb
+- lib/dragnet/cli/master.rb
+- lib/dragnet/errors.rb
+- lib/dragnet/errors/error.rb
+- lib/dragnet/errors/file_not_found_error.rb
+- lib/dragnet/errors/incompatible_repository_error.rb
+- lib/dragnet/errors/missing_timestamp_attribute_error.rb
+- lib/dragnet/errors/no_mtr_files_found_error.rb
+- lib/dragnet/errors/not_a_repository_error.rb
+- lib/dragnet/errors/repo_path_not_found_error.rb
+- lib/dragnet/errors/unable_to_write_report_error.rb
+- lib/dragnet/errors/unknown_export_format_error.rb
+- lib/dragnet/errors/validation_error.rb
+- lib/dragnet/errors/yaml_format_error.rb
+- lib/dragnet/explorer.rb
+- lib/dragnet/exporter.rb
+- lib/dragnet/exporters.rb
+- lib/dragnet/exporters/exporter.rb
+- lib/dragnet/exporters/html_exporter.rb
+- lib/dragnet/exporters/id_generator.rb
+- lib/dragnet/exporters/json_exporter.rb
+- lib/dragnet/exporters/serializers.rb
+- lib/dragnet/exporters/serializers/repo_serializer.rb
+- lib/dragnet/exporters/serializers/test_record_serializer.rb
+- lib/dragnet/exporters/serializers/verification_result_serializer.rb
+- lib/dragnet/exporters/templates/template.html.erb
+- lib/dragnet/helpers/repository_helper.rb
+- lib/dragnet/multi_repository.rb
+- lib/dragnet/repo.rb
+- lib/dragnet/repository.rb
+- lib/dragnet/test_record.rb
+- lib/dragnet/validator.rb
+- lib/dragnet/validators.rb
+- lib/dragnet/validators/data_validator.rb
+- lib/dragnet/validators/entities.rb
+- lib/dragnet/validators/entities/repo_validator.rb
+- lib/dragnet/validators/entities/test_record_validator.rb
+- lib/dragnet/validators/fields.rb
+- lib/dragnet/validators/fields/description_validator.rb
+- lib/dragnet/validators/fields/field_validator.rb
+- lib/dragnet/validators/fields/files_validator.rb
+- lib/dragnet/validators/fields/id_validator.rb
+- lib/dragnet/validators/fields/meta_data_field_validator.rb
+- lib/dragnet/validators/fields/path_validator.rb
+- lib/dragnet/validators/fields/repos_validator.rb
+- lib/dragnet/validators/fields/result_validator.rb
+- lib/dragnet/validators/fields/sha1_validator.rb
+- lib/dragnet/validators/files_validator.rb
+- lib/dragnet/validators/repos_validator.rb
+- lib/dragnet/validators/validator.rb
+- lib/dragnet/verification_result.rb
+- lib/dragnet/verifier.rb
+- lib/dragnet/verifiers.rb
+- lib/dragnet/verifiers/changes_verifier.rb
+- lib/dragnet/verifiers/files_verifier.rb
+- lib/dragnet/verifiers/repos_verifier.rb
+- lib/dragnet/verifiers/repository_verifier.rb
+- lib/dragnet/verifiers/result_verifier.rb
+- lib/dragnet/verifiers/test_record_verifier.rb
+- lib/dragnet/verifiers/verifier.rb
+- lib/dragnet/version.rb
+homepage: https://github.com/esrlabs/dragnet
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/esrlabs/dragnet
+  source_code_uri: https://github.com/esrlabs/dragnet
+  changelog_uri: https://github.com/esrlabs/dragnet/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A gem to verify, validate and analyse MTR (Manual Test Record) files.
+test_files: []