capistrano-slacky 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386586f5b65ad40376cdf7e1fcd1bb915445c8142bb1159027da83acbda7fc48
-  data.tar.gz: e7a7ce2418418b4285401c8b5d737284d9d9b2930ac1c7f9514c33a49b3cb2d7
+  metadata.gz: 7d8a000422ee77540816f23c92063aaafbc39d62c1d7328bca687abe74c42976
+  data.tar.gz: 96fea627fc2ef504cb8597a3c4c904ac75fda310b142f4e0e700e96659b9a6ea
 SHA512:
-  metadata.gz: ab2a70933589f9e2b0f1c664c5f83aa349862d945484b395d411b8c624fc3c089d147ae392e892793cb313419cd91e12b0e40c005f1847af5dfff61d667ef994
-  data.tar.gz: d84c8b2287b2a08c3b140e09e8dcc9bd51a363909a5e7f18ce9b7a3ee7753c07ca6e6bdc84cde690011879bcbd1ade0f5999b18b1e39ac902a5b85cc50734b8b
+  metadata.gz: a2290b5b024df873244e1a0196befec28381519aa5ad8ccdecf5c2d67931e0653cc68fc8c4325809381a038d8fe890ccff88dcfdb6969994337ffc61ad52d7d4
+  data.tar.gz: bbca074fb05c97288aecbdf858cfcdb03dabbcd2cc969c183e42d39f17e9f32171cb29f5fe762e6df3301dbaf3fb71d88e703312d37adedc2f4a7b64a9984689

data/CHANGELOG.md

@@ -4,11 +4,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.1.2] - 2021-06-03
+### Changed
+- Use `I18n.t` instead of `t`. ([@chubchenko][])
+- Use `forwardable` instead of `method_missing` + `respond_to_missing?`. ([@chubchenko][])
+- Use the `On` module to interact with the remote server. ([@chubchenko][])
+- Extracted hooks and defaults from `slacky.rake` into separate files. ([@chubchenko][])
+- Renamed `#to_json` to `#as_json`. ([@chubchenko][])
+- Updated hooks from `before` to `after`. ([@chubchenko][])
+- Added 💯 test coverage. ([@chubchenko][])
+
+### Fixed
+- Use `@env` instance variable instead of missing getter `env`. ([@chubchenko][])
+- Update your SSH regex to match the repository with a dash in the name. ([@chubchenko][])
+- Use `SSHKit::Backend.current.capture` instead of `IO.popen` to perform `git log ..` on the remote server. ([@chubchenko][])
+
+### Security
+- Fix possible command injection during the duration retrieval. ([@chubchenko][])
 
 ## [0.1.1] - 2021-05-27
 ### Fixed
-- Fix a bug related to using a `Null` messaging
+- Fix a bug related to using a `Null` messaging. ([@chubchenko][])
 
 ## [0.1.0] - 2021-05-26
 ### Added
@@ -16,5 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [@chubchenko]: https://github.com/chubchenko
 [Unreleased]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...HEAD
+[0.1.2]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/chubchenko/capistrano-slacky/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/chubchenko/capistrano-slacky/releases/tag/v0.1.0

data/README.md

@@ -8,6 +8,7 @@ Send `Capistrano` deployment status to `Slack`.
 
 [MIT][3]
 
-[1]: https://github.com/chubchenko/capistrano-slacky/workflows/build/badge.svg
-[2]: https://github.com/chubchenko/capistrano-slacky/actions
+
+[1]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml/badge.svg
+[2]: https://github.com/chubchenko/capistrano-slacky/actions/workflows/build.yml
 [3]: https://choosealicense.com/licenses/mit

data/lib/capistrano/slacky.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 load File.expand_path("../../tasks/slacky.rake", __FILE__)
+load File.expand_path("../../tasks/hooks.rake", __FILE__)
+load File.expand_path("../../tasks/defaults.rake", __FILE__)
 
 require_relative "slacky/version"
 require_relative "slacky/configuration"
@@ -9,24 +11,19 @@ require_relative "slacky/runner"
 require_relative "slacky/block"
 require_relative "slacky/facade"
 require_relative "slacky/command"
+require_relative "slacky/on"
 
 module Capistrano
   module Slacky
-    module_function
+    require "forwardable"
 
-    # Delegate any missing method call to the configuration
-    def method_missing(method_name, *arguments, &block)
-      return super unless configuration.respond_to?(method_name)
+    module_function
 
-      configuration.public_send(method_name, *arguments, &block)
-    end
+    extend ::SingleForwardable
 
-    # Replace the Object.respond_to?() method
-    def respond_to_missing?(method_name, include_private = false)
-      configuration.respond_to?(method_name) || super
-    end
+    def_delegators :configuration, :username, :icon_emoji, :channel, :klass, :slacky?, :repo
+    def_delegator :"Capistrano::Slacky::On", :on
 
-    # @return [Capistrano::Slacky::Configuration]
     def configuration
       @configuration ||= ::Capistrano::Slacky::Configuration.new
     end

data/lib/capistrano/slacky/block/context.rb

@@ -10,10 +10,10 @@ module Capistrano
           end
         end
 
-        def to_json
+        def as_json
           {
             type: :context,
-            elements: @elements.map(&:to_json)
+            elements: @elements.map(&:as_json)
           }
         end
 
@@ -22,7 +22,7 @@ module Capistrano
             @text = text
           end
 
-          def to_json
+          def as_json
             {
               type: :mrkdwn,
               text: @text

data/lib/capistrano/slacky/block/header.rb

@@ -8,7 +8,7 @@ module Capistrano
           @text = text
         end
 
-        def to_json
+        def as_json
           {
             type: :header,
             text: {

data/lib/capistrano/slacky/block/root.rb

@@ -8,9 +8,9 @@ module Capistrano
           @blocks = blocks.flatten
         end
 
-        def to_json
+        def as_json
           {
-            blocks: @blocks.map(&:to_json)
+            blocks: @blocks.map(&:as_json)
           }
         end
       end

data/lib/capistrano/slacky/block/section.rb

@@ -10,10 +10,10 @@ module Capistrano
           end
         end
 
-        def to_json
+        def as_json
           {
             type: :section,
-            fields: @fields.map(&:to_json)
+            fields: @fields.map(&:as_json)
           }
         end
 
@@ -22,7 +22,7 @@ module Capistrano
             @text = text
           end
 
-          def to_json
+          def as_json
             {
               type: :mrkdwn, text: @text
             }

data/lib/capistrano/slacky/command/diff.rb

@@ -5,7 +5,13 @@ module Capistrano
     module Command
       class Diff
         def self.call(previous:, current:)
-          new(previous: previous, current: current).call
+          output = nil
+
+          ::Capistrano::Slacky.on(within: :repository) do
+            output = new(previous: previous, current: current).call
+          end
+
+          output
         end
 
         def initialize(previous:, current:)
@@ -14,15 +20,15 @@ module Capistrano
         end
 
         def call
-          diff = ::IO.popen(
-            ["git", "log", "--oneline", "--first-parent", "#{previous}..#{current}"]
-          ).readlines
+          log = ::SSHKit::Backend.current.capture(
+            :git, :log, "--oneline", "--first-parent", "#{previous}..#{current}"
+          ).split("\n")
 
-          diff.map.with_index(1) do |line, index|
+          log.map.with_index(1) do |line, index|
             sha, commit = line.match(/^(\w+) (.*+?)/).captures
 
             if /^Merge pull request/.match?(commit)
-              commit = ::IO.popen(["git", "log", "-1", sha, '--pretty=format:"%b"']).readline
+              commit = ::SSHKit::Backend.current.capture(:git, :log, "-1", sha, '--pretty=format:"%b"')
             end
 
             Message.new(index: index, sha: sha, commit: commit)

data/lib/capistrano/slacky/command/duration.rb

@@ -5,7 +5,7 @@ module Capistrano
     module Command
       class Duration
         def self.call(pid: $PID)
-          `ps -p #{pid} -o etime=`.strip
+          ::IO.popen(["ps", "-p", pid.to_s, "-o", "etime="]).readline.strip
         end
       end
     end

data/lib/capistrano/slacky/configuration.rb

@@ -37,14 +37,14 @@ module Capistrano
 
       def repo
         @repo ||= Repo.new(
-          remote: env.fetch(:repo_url)
+          remote: @env.fetch(:repo_url)
         )
       end
 
       private
 
       def data
-        @data ||= env.fetch(:slacky, {})
+        @data ||= @env.fetch(:slacky, {})
       end
 
       class Repo
@@ -64,7 +64,7 @@ module Capistrano
         end
 
         def ssh?
-          @remote.match?(/((git|ssh|http(s)?)|(git@[\w.]+))(:(\/)?)([\w.@:\/-~]+)(\.git)(\/)?/)
+          @remote.match?(/((git|ssh|http(s)?)|(git@[\w.]+))(:(\/)?)([\w.@:\/~-]+)(\.git)(\/)?/)
         end
       end
 

data/lib/capistrano/slacky/facade/body.rb

@@ -8,9 +8,9 @@ module Capistrano
           @env = env
 
           super(
-            t("slacky.stage"), "`#{stage}`",
-            t("slacky.branch"), "`#{branch}`",
-            t("slacky.duration"), "`#{duration}`",
+            ::I18n.t("slacky.stage", scope: "capistrano"), "`#{stage}`",
+            ::I18n.t("slacky.branch", scope: "capistrano"), "`#{branch}`",
+            ::I18n.t("slacky.duration", scope: "capistrano"), "`#{duration}`",
           )
         end
 

data/lib/capistrano/slacky/facade/changelog.rb

@@ -11,25 +11,17 @@ module Capistrano
           ).call
         end
 
-        attr_accessor :difference
-
         def initialize(previous:, current:)
-          ref = self
-
-          on(::Capistrano::Configuration.env.primary(:app)) do
-            within repo_path do
-              ref.difference = ::Capistrano::Slacky::Command::Diff.call(
-                previous: previous,
-                current: current
-              )
-            end
-          end
+          @difference = ::Capistrano::Slacky::Command::Diff.call(
+            previous: previous,
+            current: current
+          )
         end
 
         def call
           if difference.empty?
             return ::Capistrano::Slacky::Block::Context.new(
-              t("slacky.nothing_has_changed_since_the_previous_release")
+              ::I18n.t("slacky.nothing_has_changed_since_the_previous_release", scope: "capistrano")
             )
           end
 
@@ -39,6 +31,10 @@ module Capistrano
             )
           end
         end
+
+        private
+
+        attr_reader :difference
       end
     end
   end

data/lib/capistrano/slacky/facade/deployed_by.rb

@@ -6,7 +6,7 @@ module Capistrano
       class DeployedBy < ::Capistrano::Slacky::Block::Context
         def initialize(env:)
           super(
-            t("slacky.deployed_by", deployer: env.fetch(:local_user))
+            ::I18n.t("slacky.deployed_by", scope: "capistrano", deployer: env.fetch(:local_user))
           )
         end
       end

data/lib/capistrano/slacky/facade/exception.rb

@@ -6,7 +6,7 @@ module Capistrano
       class Exception < ::Capistrano::Slacky::Block::Context
         DefaultException = ::Class.new(::StandardError) do
           def initialize
-            super(t("slacky.something_went_wrong"))
+            super(::I18n.t("slacky.something_went_wrong", scope: "capistrano"))
           end
         end
 

data/lib/capistrano/slacky/facade/header.rb

@@ -39,7 +39,7 @@ module Capistrano
         }.freeze
 
         def initialize(text)
-          super(t("slacky.#{text}", emoji: EMOJI_MAP.fetch(text).sample))
+          super(::I18n.t("slacky.#{text}", scope: "capistrano", emoji: EMOJI_MAP.fetch(text).sample))
         end
       end
     end

data/lib/capistrano/slacky/facade/revision.rb

@@ -8,9 +8,10 @@ module Capistrano
           @env = env
 
           super(
-            t("slacky.revision", repository_url: ::Capistrano::Slacky.repo.url,
-                                 current: current,
-                                 previous: previous)
+            I18n.t("slacky.revision", scope: "capistrano",
+                                      repository_url: ::Capistrano::Slacky.repo.url,
+                                      current: current,
+                                      previous: previous)
           )
         end
 

data/lib/capistrano/slacky/fanout.rb

@@ -9,19 +9,15 @@ module Capistrano
 
       module_function
 
-      def uri(role: Hook.role)
+      def uri
         output = nil
 
-        on(role) do
-          output = capture(:cat, File.join(shared_path, DEFAULT_HOOK_FILE))
+        ::Capistrano::Slacky.on(within: :shared) do
+          output = ::SSHKit::Backend.current.capture(:cat, DEFAULT_HOOK_FILE)
         end
 
         URI(output)
       end
-
-      def role
-        ::Capistrano::Configuration.env.primary(:app)
-      end
     end
 
     private_constant :Hook

data/lib/capistrano/slacky/messaging.rb

@@ -10,7 +10,7 @@ module Capistrano
       def self.for(env:)
         klass =
           if ::Capistrano::Slacky.slacky?
-            (::Capistrano::Slacky.klass || Default)
+            (::Capistrano::Slacky.klass || ::Capistrano::Slacky::Messaging::Default)
           else
             Null
           end

data/lib/capistrano/slacky/messaging/default.rb

@@ -11,7 +11,7 @@ module Capistrano
             ::Capistrano::Slacky::Facade::Revision.new(env: env),
             ::Capistrano::Slacky::Facade::Changelog.for(env: env),
             ::Capistrano::Slacky::Facade::DeployedBy.new(env: env)
-          ).to_json
+          ).as_json
         end
 
         def payload_for_reverted
@@ -20,7 +20,7 @@ module Capistrano
             ::Capistrano::Slacky::Facade::Body.new(env: env),
             ::Capistrano::Slacky::Facade::Revision.new(env: env),
             ::Capistrano::Slacky::Facade::DeployedBy.new(env: env)
-          ).to_json
+          ).as_json
         end
 
         def payload_for_failed
@@ -29,7 +29,13 @@ module Capistrano
             ::Capistrano::Slacky::Facade::Body.new(env: env),
             ::Capistrano::Slacky::Facade::Exception.new,
             ::Capistrano::Slacky::Facade::DeployedBy.new(env: env)
-          ).to_json
+          ).as_json
+        end
+
+        private
+
+        def deploying?
+          env.fetch(:deploying, false)
         end
       end
     end

data/lib/capistrano/slacky/on.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Slacky
+    module On
+      class Path
+        extend ::Capistrano::DSL
+      end
+
+      PATH_MAP = {
+        repository: -> { Path.repo_path },
+        shared: -> { Path.shared_path }
+      }.freeze
+
+      private_constant :PATH_MAP
+
+      module_function
+
+      def on(within:, &block)
+        ::Capistrano::DSL.on(::Capistrano::Configuration.env.primary(:app)) do
+          ::SSHKit::Backend.current.within(PATH_MAP.fetch(within).call, &block)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/slacky/runner.rb

@@ -6,7 +6,7 @@ require_relative "fanout"
 module Capistrano
   module Slacky
     class Runner
-      def self.call(env:, action:)
+      def self.call(action:, env: ::Capistrano::Configuration.env)
         payload = ::Capistrano::Slacky::Payload.new(
           env: env, action: action
         )

data/lib/capistrano/slacky/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Slacky
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/tasks/defaults.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+namespace :load do
+  task :defaults do
+    append :linked_files, "config/slacky.yml"
+  end
+end

data/lib/tasks/hooks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+after :'deploy:finishing', :'slacky:updated'
+after :'deploy:finishing_rollback', :'slacky:reverted'
+after :'deploy:failed', :'slacky:failed'

data/lib/tasks/slacky.rake

@@ -3,40 +3,26 @@
 namespace :slacky do
   desc "Slacky after a successful deployment"
   task :updated do
-    Capistrano::Slacky::Runner.call(
-      env: self, action: :updated
-    )
+    Capistrano::Slacky::Runner.call(action: :updated)
   end
 
   desc "Slacky after successful rollback"
   task :reverted do
-    Capistrano::Slacky::Runner.call(
-      env: self, action: :reverted
-    )
+    Capistrano::Slacky::Runner.call(action: :reverted)
   end
 
   desc "Slacky after failure deployment or rollback"
   task :failed do
-    Capistrano::Slacky::Runner.call(
-      env: self, action: :failed
-    )
+    Capistrano::Slacky::Runner.call(action: :failed)
   end
 
-  # task :ping do
-  #   [:updated, :reverted, :failed].each do |action|
-  #     Capistrano::Slacky::Runner.call(
-  #       env: self, action: action
-  #     )
-  #   end
-  # end
-end
-
-before :'deploy:finishing', :'slacky:updated'
-before :'deploy:finishing_rollback', :'slacky:reverted'
-before :'deploy:failed', :'slacky:failed'
+  desc "Slacky all slackable task (updated, reverted, failed)"
+  task :ping do
+    ask(:previous_revision) unless env.any?(:previous_revision)
+    ask(:current_revision) unless env.any?(:current_revision)
 
-namespace :load do
-  task :defaults do
-    append :linked_files, "config/slacky.yml"
+    [:updated, :reverted, :failed].each do |action|
+      Capistrano::Slacky::Runner.call(action: action)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-slacky
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -72,20 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
 description: Send Capistrano deployment status to Slack via the incoming webhooks
   integration
 email: artem.chubchenko@gmail.com
@@ -121,9 +107,12 @@ files:
 - lib/capistrano/slacky/messaging/base.rb
 - lib/capistrano/slacky/messaging/default.rb
 - lib/capistrano/slacky/messaging/null.rb
+- lib/capistrano/slacky/on.rb
 - lib/capistrano/slacky/payload.rb
 - lib/capistrano/slacky/runner.rb
 - lib/capistrano/slacky/version.rb
+- lib/tasks/defaults.rake
+- lib/tasks/hooks.rake
 - lib/tasks/slacky.rake
 homepage: https://github.com/chubchenko/capistrano-slacky
 licenses: