capistrano-sentry 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fd747d897527e62a5ac086ebc361a5c4b166c059d7c3596b85f7b2a776374f
-  data.tar.gz: ce63a3acb315cc6b3c96fc01a968032e8a98d4ea080d21eedfe3bc17cb42a3c2
+  metadata.gz: 1309178927aac5e5af01a3dd3e42ed491dd88c6915ab250d419b9ead97f630ca
+  data.tar.gz: 28bcd3f86fbdfacec11a91e58e98df9df216c924db5022b1138450a11de1c056
 SHA512:
-  metadata.gz: 9b3ccae3566b22f9fa686821dae840b0ddd63aa49f9dea6a3d1eaad27802ad33933f650be0706f8ad4c2cf3f10f53035a263a859385577263ff0b6a5d338a826
-  data.tar.gz: 5e85c1e6d80eaa6dcf43af44ec0e70f76f3de0d31028b0481ea22922501ca73ae350bfda417d1b8af152c7999398911331ad73703fb55f59cbb012af776e198f
+  metadata.gz: c6964c9789df72462efb1b3f6c0e90625904f7d173403277815358f38f36377ece78807766966a214d2ae4d0981d07fe7c98eda0d37f7d69f3d092b5b5cb1bd0
+  data.tar.gz: 8c210ac87ef38e0758f95cb5410759adf0f9abfa3b6cbc00c33c427e0aa2e312a5acac3cc09463048b29993e484665c2fcc7f18552a2ae9fa743a2ef9a01e58f

data/.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [ '3.4' ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Retrieve gems cache
+        uses: actions/cache@v5
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+
+      - name: Install gems
+        run: |
+          rm -f .ruby-version
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake test
+
+      - name: Upload log if failure
+        uses: actions/upload-artifact@v6
+        if: failure()
+        with:
+          name: test.log
+          path: log/test.log

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+  IndentationWidth: 2
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 65
+
+Metrics/BlockLength:
+  Max: 70
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/FileName:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/GuardClause:
+  MinBodyLength: 3
+
+Style/HashEachMethods:
+  Enabled: true
+  AutoCorrect: true
+
+Style/HashTransformKeys:
+  Enabled: true
+  AutoCorrect: true
+
+Style/HashTransformValues:
+  Enabled: true
+  AutoCorrect: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SymbolArray:
+  MinSize: 7

data/Gemfile

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in capistrano-sentry.gemspec
 gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '>= 10'

data/README.md

@@ -33,9 +33,10 @@ set :sentry_api_token, '0123456789abcdef0123456789abcdef'
 set :sentry_organization, 'my-org' # fetch(:application) by default
 set :sentry_project, 'my-proj'     # fetch(:application) by default
 set :sentry_repo, 'my-org/my-proj' # computed from repo_url by default
+set :sentry_stages, %w[production] # only these stages create releases and deploys, %w[production] by default
 ```
 
-If you want deployments to be published in every Rails environment, put this in `config/deploy.rb`, otherwise put it your environment-specific deploy file (i.e. `config/deploy/production.rb`):
+Then hook the tasks in `config/deploy.rb`:
 ```ruby
 before 'deploy:starting', 'sentry:validate_config'
 after 'deploy:published', 'sentry:notice_deployment'
@@ -56,6 +57,8 @@ after 'deploy:published', 'sentry:notice_deployment'
 
 * `sentry_repo`: The `repository` name to be used when reporting repository details to Sentry [computed from `fetch(:repo_url)` by default -- `https://github.com/codeur/capistrano-sentry` becomes `//github.com/codeur/capistrano-sentry` and `git@github.com:codeur/capistrano-sentry.git` becomes `codeur/capistrano-sentry`]
 
+* `sentry_stages`: the Capistrano stages allowed to create releases and deploys in Sentry. Both tasks are skipped for any other stage, so a staging deploy never creates a release. [`%w[production]` by default]
+
 * `sentry_repo_integration`: this enables/disables submission of git repo information (`release_refs` below) to Sentry [Enabled (`true`) by default].
 
 * `sentry_release_refs`: Repository details about this realease (`repository`, `commit`, `previousCommit`) to Sentry [computed from `sentry_repo`, `current_revision`, and `previous_revision`)].

data/Rakefile

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
+  t.warning = false # capistrano itself triggers circular require warnings
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'capistrano/sentry'

data/capistrano-sentry.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'capistrano/sentry/version'
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Brice Texier']
   spec.email         = ['brice@codeur.com']
   spec.description   = 'Sentry release/deployment integration'
-  spec.summary       = 'Sentry release/deployment integration'
+  spec.summary       = 'Push release and deployment information on Sentry on each deploy'
   spec.homepage      = 'https://github.com/codeur/capistrano-sentry'
   spec.license       = 'MIT'
 
@@ -23,8 +25,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '~> 3.1'
-
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/capistrano/sentry/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Capistrano
   module Sentry
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'
   end
 end

data/lib/capistrano/sentry.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 load File.expand_path('tasks/sentry.rake', __dir__)

data/lib/capistrano/tasks/sentry.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This task will notify Sentry via their API[1][2] that you have deployed
 # a new release. It uses the commit hash as the `version` and the git ref as
 # the optional `ref` value.
@@ -13,15 +15,26 @@ module Capistrano
 end
 
 namespace :sentry do
+  # Only the stages listed in `:sentry_stages` (`production` by default) notify Sentry.
+  def sentry_stage_enabled?
+    Array(fetch(:sentry_stages, %w[production])).map(&:to_s).include?(fetch(:stage).to_s)
+  end
+
   desc 'Confirm configuration for notification to Sentry'
   task :validate_config do
     run_locally do
+      unless sentry_stage_enabled?
+        info "[sentry:validate_config] Skipped: stage #{fetch(:stage).inspect} is not listed in :sentry_stages"
+        next
+      end
+
       info '[sentry:validate_config] Validating Sentry notification config'
       api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
       if api_token.nil? || api_token.empty?
-        msg = "Missing SENTRY_API_TOKEN. Please set SENTRY_API_TOKEN environment variable or `set :sentry_api_token` in your `config/deploy.rb` file for your Rails application."
+        msg = 'Missing SENTRY_API_TOKEN. Please set SENTRY_API_TOKEN environment' \
+          ' variable or `set :sentry_api_token` in your `config/deploy.rb` file for your Rails application.'
         warn msg
-        fail Capistrano::SentryConfigurationError, msg
+        raise Capistrano::SentryConfigurationError, msg
       end
     end
   end
@@ -29,6 +42,11 @@ namespace :sentry do
   desc 'Notice new deployment in Sentry'
   task :notice_deployment do
     run_locally do
+      unless sentry_stage_enabled?
+        info "[sentry:notice_deployment] Skipped: stage #{fetch(:stage).inspect} is not listed in :sentry_stages"
+        next
+      end
+
       require 'uri'
       require 'net/https'
       require 'json'
@@ -43,9 +61,9 @@ namespace :sentry do
       api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
       repo_integration_enabled = fetch(:sentry_repo_integration, true)
       release_refs = fetch(:sentry_release_refs, [{
-        repository: fetch(:sentry_repo) || fetch(:repo_url).split(':').last.gsub(/\.git$/, ''),
-        commit: head_revision,
-        previousCommit: prev_revision,
+        repository:     fetch(:sentry_repo) || fetch(:repo_url).split(':').last.delete_suffix('.git'),
+        commit:         head_revision,
+        previousCommit: prev_revision
       }])
       release_version = fetch(:sentry_release_version) || head_revision
       deploy_name = fetch(:sentry_deploy_name) || "#{release_version}-#{fetch(:release_timestamp)}"
@@ -55,24 +73,27 @@ namespace :sentry do
       http.use_ssl = true
 
       headers = {
-        'Content-Type' => 'application/json',
-        'Authorization' => 'Bearer ' + api_token.to_s,
+        'Content-Type'  => 'application/json',
+        'Authorization' => 'Bearer ' + api_token.to_s
       }
 
       req = Net::HTTP::Post.new("/api/0/organizations/#{organization_slug}/releases/", headers)
       body = {
-        version: release_version,
-        projects: [project],
+        version:  release_version,
+        projects: [project]
       }
       body[:refs] = release_refs if repo_integration_enabled
       req.body = JSON.generate(body)
       response = http.request(req)
       if response.is_a? Net::HTTPSuccess
         info "Notified Sentry of new release: #{release_version}"
-        req = Net::HTTP::Post.new("/api/0/organizations/#{organization_slug}/releases/#{release_version}/deploys/", headers)
+        req = Net::HTTP::Post.new(
+          "/api/0/organizations/#{organization_slug}/releases/#{release_version}/deploys/",
+          headers
+        )
         req.body = JSON.generate(
           environment: environment,
-          name: deploy_name,
+          name:        deploy_name
         )
         response = http.request(req)
         if response.is_a? Net::HTTPSuccess

data/test/capistrano/sentry_test.rb

@@ -1,11 +1,56 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class Capistrano::SentryTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil ::Capistrano::Sentry::VERSION
-  end
+module Capistrano
+  class SentryTest < TestCase
+    def test_production_creates_a_release_and_a_deploy
+      set :stage, :production
+      run_task :notice_deployment
+
+      assert_equal 2, @http.requests.size
+      release, deploy = @http.requests
+      assert_equal '/api/0/organizations/my-app/releases/', release.path
+      assert_equal 'Bearer secret', release['Authorization']
+      body = JSON.parse(release.body)
+      assert_equal 'abc123', body['version']
+      assert_equal ['my-app'], body['projects']
+      assert_equal 'my-org/my-app', body['refs'].first['repository']
+      assert_equal '/api/0/organizations/my-app/releases/abc123/deploys/', deploy.path
+      assert_equal({ 'environment' => 'production', 'name' => 'abc123-20260910120000' }, JSON.parse(deploy.body))
+      assert_includes log, 'Notified Sentry of new deployment'
+    end
+
+    def test_other_stages_do_not_notify_sentry
+      set :stage, :staging
+      run_task :notice_deployment
+
+      assert_empty @http.requests
+      assert_includes log, 'Skipped: stage :staging is not listed in :sentry_stages'
+    end
+
+    def test_sentry_stages_can_enable_other_stages
+      set :stage, :staging
+      set :sentry_stages, %w[staging production]
+      run_task :notice_deployment
+
+      assert_equal 2, @http.requests.size
+      assert_equal 'staging', JSON.parse(@http.requests.last.body)['environment']
+    end
+
+    def test_validate_config_requires_a_token_on_enabled_stages
+      set :stage, :production
+      set :sentry_api_token, nil
+
+      assert_raises(Capistrano::SentryConfigurationError) { run_task :validate_config }
+    end
+
+    def test_validate_config_is_skipped_on_other_stages
+      set :stage, :staging
+      set :sentry_api_token, nil
 
-  def test_it_does_something_useful
-    assert false
+      run_task :validate_config
+      assert_includes log, 'Skipped: stage :staging is not listed in :sentry_stages'
+    end
   end
 end

data/test/test_helper.rb

@@ -1,4 +1,62 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'capistrano/sentry'
 
+require 'capistrano/all'
+Rake.application.options.trace = false # re-enabled by capistrano/all
 require 'minitest/autorun'
+require 'stringio'
+require 'net/http'
+require 'json'
+
+include Capistrano::DSL # rubocop:disable Style/MixinUsage
+
+require 'capistrano/sentry'
+
+module Capistrano
+  # Runs Capistrano tasks against a fresh configuration, with SSHKit output captured
+  # and Sentry's HTTP API replaced by a recorder.
+  class TestCase < Minitest::Test
+    class FakeHTTP
+      attr_reader :requests
+
+      def initialize
+        @requests = []
+      end
+
+      def use_ssl=(_value); end
+
+      def request(req)
+        @requests << req
+        Net::HTTPCreated.new('1.1', '201', 'Created').tap do |response|
+          response.instance_variable_set(:@body, '{}')
+          response.instance_variable_set(:@read, true)
+        end
+      end
+    end
+
+    def setup
+      Capistrano::Configuration.reset!
+      @log = StringIO.new
+      SSHKit.config.output = SSHKit::Formatter::Pretty.new(@log)
+      SSHKit.config.output_verbosity = :debug
+      @http = FakeHTTP.new
+      set :application, 'my-app'
+      set :repo_url, 'git@github.com:my-org/my-app.git'
+      set :sentry_api_token, 'secret'
+      set :current_revision, 'abc123'
+      set :previous_revision, 'def456'
+      set :release_timestamp, '20260910120000'
+    end
+
+    def run_task(name)
+      task = Rake::Task["sentry:#{name}"]
+      task.reenable
+      Net::HTTP.stub(:new, @http) { task.invoke }
+    end
+
+    def log
+      @log.string
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sentry
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brice Texier
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,48 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 description: Sentry release/deployment integration
 email:
 - brice@codeur.com
@@ -73,8 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -93,7 +51,6 @@ homepage: https://github.com/codeur/capistrano-sentry
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -108,11 +65,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Sentry release/deployment integration
+summary: Push release and deployment information on Sentry on each deploy
 test_files:
 - test/capistrano/sentry_test.rb
 - test/test_helper.rb

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.17.1