cocov_plugin_kit 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a993db2cae820ec262839636dcec32f746ba604fefe2c421fe6ee3f559ec2f
-  data.tar.gz: 84f5d7cc669b2207405588ff063cedfe76bd585f00af7708fe2268100b8049e9
+  metadata.gz: 1a8273e71e6a782ac8eb359fe94f8a4f36214122d738f462427dc0db7ac30d99
+  data.tar.gz: 4cb89031486138bd9893297792db58e92fe6099a4ffa43f067635683cf0c8f78
 SHA512:
-  metadata.gz: f715fb0d82ee68aef358b981cd6e15ee1cd99feb216d05cf1f138eca85b550c5251c8bd248b14f009d919063379d4b25a0f899188a5156580e6bc1233fc17866
-  data.tar.gz: '0394e82212fb0fa3f5accb0302c02b0bb9682310f4e7bf162b3410a9fdc43bae18765e4d263dd19004119065c071217549e35a8a509571b5c45d64ff8a0a2d85'
+  metadata.gz: 3b59f4546faf3f18b6c45805352f6050f70b3c1cf0b8b436ce4bcbcef6e7fe2ec7a64c3f8c0faf8c0806d244d754ac286c835dac9938a4552153025835d688f9
+  data.tar.gz: 751d2360770a35d2e565142d12e502dd1932cc14c26357a305760e7ef95c6a4aae9c63d005f7657630225661014238c015907ae398ac760e0c2ff6ed7dd9440a

data/.rubocop.yml

@@ -2,6 +2,15 @@ AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -12,3 +21,16 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - plugin_kit.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Lint/RescueException:
+  Exclude:
+    - lib/cocov/plugin_kit.rb
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocov_plugin_kit (0.1.1)
+    cocov_plugin_kit (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,33 +1,69 @@
 # PluginKit
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plugin_kit`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+PluginKit implements a utility library to help the development of Cocov Plugins using the Ruby programming language.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Cocov plugins should not contain Gemfiles. Instead, install the library directly
+using the `gem install` command, providing a specific version. For instance,
+
+```
+gem install cocov_plugin_kit -v 0.1.2
+```
 
-    $ bundle add plugin_kit
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### For simple plugins
 
-    $ gem install plugin_kit
+When implementing simple plugins, like for example, [brakeman](https://github.com/cocov-ci/brakeman/blob/master/plugin.rb),
+the block-based usage of PluginKit can be used:
 
-## Usage
+```ruby
+Cocov::PluginKit.run do
+  output = JSON.parse(exec(["my", "plugin", "--format", "json"], env: ENV))
+  # Process output...
+  emit_issue kind: # ...
+end
+```
+
+### For elaborate plugins
+
+For plugins requiring more organization or several internal methods, like [rubocop](https://github.com/cocov-ci/rubocop/blob/master/plugin.rb),
+`Cocov::PluginKit::Run` can be inherited into a new class, and `#run` can be
+overridden to be used as the plugin entrypoint, followed by a call to
+`Cocov::PluginKit.run`:
+
+```ruby
+class ElaboratePlugin < Cocov::PluginKit::Run
+  def run
+    output = JSON.parse(exec(["my", "plugin", "--format", "json"], env: ENV))
+    # Process output...
+    emit_issue kind: # ...
+  end
+end
 
-TODO: Write usage instructions here
+Cocov::PluginKit.run(ElaboratePlugin)
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+A `docker-compose.yaml` is provided for allowing Ruby 2.6 to be used without
+requiring developers to install that version on their machines. When writing
+Dockerfiles, developers are advised to use the latest version available when
+building plugins.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Use `docker compose run --rm -it ruby bash` to get a shell on the container;
+`bin/setup` can be used to install dependencies, `rspec` to run tests,
+`rubocop` to lint the codebase, and `bin/console` to get an interactive console
+that allows you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plugin_kit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/plugin_kit/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/cocov-ci/plugin_kit.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Cocov's code of conduct](https://github.com/cocov-ci/.github/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the PluginKit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/plugin_kit/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Cocov project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the [Cocov's code of conduct](https://github.com/cocov-ci/.github/blob/main/CODE_OF_CONDUCT.md).

data/lib/cocov/plugin_kit/exec.rb

@@ -2,10 +2,15 @@
 
 module Cocov
   module PluginKit
+    # Exec provides utilities for executing processes and obtaining its results.
     module Exec
+      # ExecutionError is thrown when an #exec or #exec2 procedure fails. It
+      # includes the captured stdout and stderr streams, along with the exit
+      # status, the original command and its environment.
       class ExecutionError < StandardError
         attr_reader :stdout, :stderr, :status, :cmd, :env
 
+        # Internal: Initializes a new ExecutionError instance
         def initialize(status, stdout, stderr, cmd, env)
           super("Process #{cmd.split.first} exited with status #{status}")
           @status = status
@@ -18,6 +23,19 @@ module Cocov
 
       module_function
 
+      # Public: Executes a given command (represented as an array of strings),
+      # returning both its stdout and stderr streams as Strings. Extra options
+      # are passed directly to Process.spawn, except :env, which when provided
+      # must be a Hash representing environment keys and values.
+      # This function will block until the process finishes, either returning
+      # both streams (stdout, stderr) as an Array, or raising an ExecutionError.
+      #
+      # Example:
+      #
+      #   stdout, stderr = Exec::exec2(["git", "version"], chdir: "/tmp")
+      #   # stdout == "git version 2.30.2\n"
+      #   # stderr == ""
+      #
       def exec2(cmd, **options)
         out_reader, out_writer = IO.pipe
         err_reader, err_writer = IO.pipe
@@ -62,6 +80,9 @@ module Cocov
         [stdout, stderr]
       end
 
+      # Public: exec works exactly like #exec2, but only returns the stdout
+      # stream, instead of both stdout and stderr.
+      # For more information, see the documentation for #exec.
       def exec(cmd, **options)
         exec2(cmd, **options).first
       end

data/lib/cocov/plugin_kit/realloc.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Cocov
+  module PluginKit
+    # :nodoc:
+    class Realloc
+      def self.bindings
+        secrets_path = Pathname.new("/secrets")
+        bindings_path = secrets_path.join("bindings")
+        return {} if !bindings_path.exist? || bindings_path.directory?
+
+        bindings_path.read.split("\0").to_h do |entry|
+          from, to = entry.split("=", 2)
+          from_path = secrets_path.join(from)
+          to_path = Pathname.new(File.expand_path(to))
+          [from_path, to_path]
+        end
+      end
+
+      def self.mounts!
+        bindings.each do |from_path, to_path|
+          unless from_path.exist?
+            puts "Expected binding of #{from_path} to exist, but could not locate it"
+            exit 1
+          end
+
+          to_path.dirname.mkpath
+
+          FileUtils.cp from_path, to_path
+        end
+      end
+    end
+  end
+end

data/lib/cocov/plugin_kit/run.rb

@@ -2,6 +2,16 @@
 
 module Cocov
   module PluginKit
+    # Public: Run implements helpers and prepares the environment for a Plugin
+    # runtime. All Cocov Ruby plugins must either inherit this class or directly
+    # use it by using the block alternative of Cocov::PluginKit#run.
+    #
+    # The class provides the following accessors:
+    # - workdir:    The path to the root of the repository being checked. The
+    #               plugin is always executed with its pwd set to this path.
+    # - repo_name:  The name of the repository being cheked.
+    # - commit_sha: The SHA of the commit being checked.
+    #
     class Run
       attr_reader :workdir, :repo_name, :commit_sha
 
@@ -13,23 +23,34 @@ module Cocov
         @output_file = output_file
       end
 
+      # Public: When inheriting this class, the plugin entrypoint must be
+      # implemented on this method's override.
       def run; end
 
+      # Public: Alias to Exec.exec2. For more information, see the documentation
+      # for that method.
       def exec2(cmd, **options)
         Exec.exec2(cmd, **options)
       end
 
+      # Public: Alias to Exec.exec. For more information, see the documentation
+      # for that method.
       def exec(cmd, **options)
         Exec.exec(cmd, **options)
       end
 
+      # Public: Returns the SHA1 digest of the provided data
       def sha1(data)
         Digest::SHA1.hexdigest(data)
       end
 
-      ALLOWED_KINDS = %i[style performance security bug complexity duplication].freeze
+      # :nodoc:
+      ALLOWED_KINDS = %i[style performance security bug complexity duplication convention].freeze
 
-      def emit_issue(kind:, file:, line_start:, line_end:, message:, uid: nil)
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # :nodoc:
+      def validate_issue_args!(kind:, file:, line_start:, line_end:, message:, uid:)
         unless ALLOWED_KINDS.include? kind
           raise ArgumentError, "Invalid kind `#{kind}'. Valid options are #{ALLOWED_KINDS.join(", ")}"
         end
@@ -44,10 +65,35 @@ module Cocov
 
         raise ArgumentError, "message must be a non-empty string" if !message.is_a?(String) || message.strip == ""
 
-        if !uid.nil? && (!uid.is_a?(String) || uid.strip == "")
-          raise ArgumentError, "uid must be a non-empty string when provided"
-        end
+        return unless !uid.nil? && (!uid.is_a?(String) || uid.strip == "")
 
+        raise ArgumentError, "uid must be a non-empty string when provided"
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # Public: Emits a new issue with the provided arguments.
+      #
+      # kind:       - A symbol identifying kind of the issue being emitted.
+      # file:       - The path, relative to the repository root, of the file
+      #               where the issue was found.
+      # line_start: - The first line where the issue was found. Must be greater
+      #               than zero.
+      # line_end:   - The last line where the issue was found. Must be equal or
+      #               greater than the value of line_start.
+      # message:    - A message describing the issue. Must not be empty.
+      # uid:        - An uniquely identifier representing this issue among any
+      #               other possible issue in any other file in this repository.
+      #               This identifier must be the result of a pure function;
+      #               i.e. the same issue in the same file, spanning the same
+      #               lines must have the same uid no matter how many times it
+      #               is reported. If omitted, an UID is automatically
+      #               calculated. If provided, must be a non-empty string.
+      #
+      # Returns nothing. Raises ArgumentError in case invalid data is provided
+      # (see documentation above.)
+      def emit_issue(kind:, file:, line_start:, line_end:, message:, uid: nil)
+        validate_issue_args! kind: kind, file: file, line_start: line_start,
+                             line_end: line_end, message: message, uid: uid
         data = {
           kind: kind,
           file: file,

data/lib/cocov/plugin_kit/version.rb

@@ -2,6 +2,6 @@
 
 module Cocov
   module PluginKit
-    VERSION = "0.1.1"
+    VERSION = "0.1.3"
   end
 end

data/lib/cocov/plugin_kit.rb

@@ -8,21 +8,29 @@ require "tempfile"
 require "tmpdir"
 
 require_relative "plugin_kit/version"
-require_relative "plugin_kit/run"
 require_relative "plugin_kit/exec"
+require_relative "plugin_kit/realloc"
+require_relative "plugin_kit/run"
 
 module Cocov
+  # PluginKit implements helpers for implementing Cocov Plugins in Ruby. The
+  # main module provides a single run function that must be used to wrap the
+  # plugin runtime, and is responsible for preparing the environment and running
+  # the provided block
   module PluginKit
-    class Error < StandardError; end
-
     module_function
 
+    # Public: Prepares the environment and executes a given `klass` (Class) or
+    # a single block. When `klass` is not provided, PluginKit::Run is used.
+    # When providing a custom class, make sure to inherit PluginKit::Run.
+    # For examples, see the library's README file.
     def run(klass = nil, &block)
       output_file = File.open(ENV.fetch("COCOV_OUTPUT_FILE"), "w")
       exit_code = 0
       klass ||= Run
       instance = klass.new(output_file)
       Dir.chdir(instance.workdir) do
+        Realloc.mounts!
         if block_given?
           instance.instance_exec(&block)
         else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocov_plugin_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Victor Gama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-07 00:00:00.000000000 Z
 dependencies: []
 description: PluginKit implements helpers for running Cocov plugins
 email:
@@ -21,15 +21,16 @@ files:
 - ".editorconfig"
 - ".rspec"
 - ".rubocop.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- cocov.output.bin
 - exe/cocov
 - lib/cocov/plugin_kit.rb
 - lib/cocov/plugin_kit/exec.rb
+- lib/cocov/plugin_kit/realloc.rb
 - lib/cocov/plugin_kit/run.rb
 - lib/cocov/plugin_kit/version.rb
 homepage: https://github.com/cocov-ci/plugin_kit

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hey@vito.io. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.