capistrano-sentry 0.1.5 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b604bc26d4b0cf71021d043bbe11976c97f434ec2ada60305775be65e25ca83a
-  data.tar.gz: dfdaddac07ac73247e7766146f759a6326ce2c030f9c8f59fb337d88b172495f
+  metadata.gz: aa08b17ff84fe1b532e61db8eb1523386d1067fdbebb2f1e35e08ea3838321a7
+  data.tar.gz: 37f28cfb7948b2f466459edc77d415df07110792c4aeb195e0c9b9ae3c41ba3a
 SHA512:
-  metadata.gz: 46ee1f6c34b8c7d363ce49fdf7400dfec5f7b551ac6a69b73fcc934e1e47268a40a831aaf226d7c0ba3d43fe5586bbd91cc7a17ddad91c67f9e16d0b0873ecf9
-  data.tar.gz: 1c765c330033504b7126b20a060e1231abbdaf2a2f71368ac752c0d022dfd64c2aea275d62f85bd61ecbcf481678871afe15de778ddffea62b7a685ed7667dfd
+  metadata.gz: 2f29484e5511e9a3c6a2446c4ce50910e8eeb06ca9bcce512322ea111bfed2ff18e747378deee98389fb34c7e659315d0ff35f512252e6196e627c9bf66574ae
+  data.tar.gz: 7aa867b34a28f3fca952372e847134326df5210872b634db857497ba5e080223302534a28535eeb06e5de2c616d21240c246ea7768c8908c496bdf2e122be0b8

data/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [ '2.6' ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Retrieve gems cache
+        uses: actions/cache@v1.1.2
+        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@v1
+        if: failure()
+        with:
+          name: test.log
+          path: log/test.log

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-*~
+Gemfile.lock
+*~

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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/README.md

@@ -2,15 +2,12 @@
 
 Simple extension of capistrano for automatic notification of Sentry.
 
-TODO: Prevent user at deployment start if missing parameter to inform sentry
-      properly
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'capistrano-sentry'
+gem 'capistrano-sentry', require: false
 ```
 
 Then, add this line to your application's Capfile:
@@ -19,9 +16,11 @@ Then, add this line to your application's Capfile:
 require 'capistrano/sentry'
 ```
 
-And then execute:
+And then execute from your command line:
 
-    $ bundle
+```bash
+bundle
+```
 
 ## Usage
 
@@ -29,14 +28,46 @@ Add these lines to your application's `config/deploy.rb`:
 
 ```ruby
 # Sentry deployment notification
-set :sentry_api_token, 'd9fe44a1cf34e63993e258dbecf42158918d407978a1bb72f8fb5886aa5f9fe1'
+set :sentry_host, 'https://my-sentry.mycorp.com' # https://sentry.io by default
+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
+```
 
+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`):
+```ruby
+before 'deploy:starting', 'sentry:validate_config'
 after 'deploy:published', 'sentry:notice_deployment'
 ```
 
+### Explaination of Configuration Properties
+
+* `sentry_host`: identifies to which host Sentry submissions are sent. [https://sentry.io by default]
+
+* `sentry_api_token`: API Auth Tokens are found/created in you Sentry Account Settings (not in the organization or project): `Settings > Account > Api > Auth Tokens`.
+ [https://sentry.io/settings/account/api/auth-tokens/]
+
+* `sentry_organization`: The "**Name**" ("*A unique ID used to identify this organization*") from Sentry's Organization Settings page.
+[https://sentry.io/settings/{ORGANIZATION_SLUG}]
+
+* `sentry_project`: The "**Name**" ("*A unique ID used to identify this project*") from Sentry's Project Settings page.
+[https://sentry.io/settings/{ORGANIZATION_SLUG}/projects/{PROJECT_SLUG}]
+
+* `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_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`)].
+
+* `sentry_release_version`: Version number (tag, etc.) used to identify this release to Sentry [computed from `current_revision` or repository `HEAD`)].
+
+* `deploy_name`: A name (revision, version number, tag, etc.) used to identify this release deploy to Sentry [computed from `sentry_release_version`+`fetch(:release_timestamp)`)].
+
+### Sentry API Documentation
+* [Project Releases](https://docs.sentry.io/api/releases/post-project-releases/)
+* [Release Deploys](https://docs.sentry.io/api/releases/post-release-deploys/)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

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'
@@ -7,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = Capistrano::Sentry::VERSION
   spec.authors       = ['Brice Texier']
   spec.email         = ['brice@codeur.com']
-
-  spec.summary       = 'Sentry release/deployment integration'
+  spec.description   = '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'
 
@@ -26,5 +28,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 10'
 end

data/lib/capistrano/sentry.rb

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

data/lib/capistrano/sentry/version.rb

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

data/lib/capistrano/tasks/sentry.rake

@@ -1,65 +1,88 @@
-# This task will notify Sentry via their API[1] that you have deployed
-# a new release. It uses the release timestamp as the `version`
-# (like 20151113182847) and the git ref as the optional `ref` value.
-#
-# This task requires several environment variables be set (or just
-# hardcode the values in here if you like living on the edge):
-#
-#   ENV['SENTRY_API_ENDPOINT'] : API endpoint, https://app.getsentry.com
-#   ENV['SENTRY_ORG']          : the organization for this app
-#   ENV['SENTRY_PROJECT']      : the project for this app
-#   ENV['SENTRY_AUTH_TOKEN']   : a valid Auth token (replaces API Key)
+# 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.
 #
-# [1]: https://docs.getsentry.com/hosted/api/releases/post-project-releases
+# [1]: https://docs.sentry.io/api/releases/post-project-releases/
+# [2]: https://docs.sentry.io/api/releases/post-release-deploys/
 
 # For Rails app, this goes in config/deploy.rb
 
+module Capistrano
+  class SentryConfigurationError < StandardError
+  end
+end
+
 namespace :sentry do
-  desc 'Notice new deployment in Sentry (sentry.io)'
+  desc 'Confirm configuration for notification to Sentry'
+  task :validate_config do
+    run_locally do
+      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.'
+        warn msg
+        raise Capistrano::SentryConfigurationError, msg
+      end
+    end
+  end
+
+  desc 'Notice new deployment in Sentry'
   task :notice_deployment do
     run_locally do
       require 'uri'
       require 'net/https'
       require 'json'
 
-      uri = URI.parse('https://sentry.io')
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
+      head_revision = fetch(:current_revision) || `git rev-parse HEAD`.strip
+      prev_revision = fetch(:previous_revision) || `git rev-parse #{fetch(:current_revision)}^`.strip
 
-      version = `git rev-parse HEAD`.strip
-
-      orga_slug = fetch(:sentry_organization) || fetch(:application)
+      sentry_host = ENV['SENTRY_HOST'] || fetch(:sentry_host, 'https://sentry.io')
+      organization_slug = fetch(:sentry_organization) || fetch(:application)
       project = fetch(:sentry_project) || fetch(:application)
       environment = fetch(:stage) || 'default'
       api_token = ENV['SENTRY_API_TOKEN'] || fetch(:sentry_api_token)
-      repo_name = fetch(:sentry_repo) || fetch(:repo_url).split(':').last.gsub(/\.git$/, '')
+      repo_integration_enabled = fetch(:sentry_repo_integration, true)
+      release_refs = fetch(:sentry_release_refs, [{
+        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)}"
+
+      uri = URI.parse(sentry_host)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
 
       headers = {
-        'Content-Type' => 'application/json',
+        'Content-Type'  => 'application/json',
         'Authorization' => 'Bearer ' + api_token.to_s
       }
 
-      req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/", headers)
-      req.body = JSON.generate(
-        version: version,
-        refs: [{
-          repository: repo_name,
-          commit: fetch(:current_revision) || `git rev-parse HEAD`.strip,
-          # previousCommit: fetch(:previous_revision)
-        }],
+      req = Net::HTTP::Post.new("/api/0/organizations/#{organization_slug}/releases/", headers)
+      body = {
+        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 'Uploaded release infos to Sentry'
-        req = Net::HTTP::Post.new("/api/0/organizations/#{orga_slug}/releases/#{version}/deploys/", headers)
+        info "Notified Sentry of new release: #{release_version}"
+        req = Net::HTTP::Post.new(
+          "/api/0/organizations/#{organization_slug}/releases/#{release_version}/deploys/",
+          headers
+        )
         req.body = JSON.generate(
           environment: environment,
-          name: "#{version}-#{fetch(:release_timestamp)}"
+          name:        deploy_name
         )
         response = http.request(req)
         if response.is_a? Net::HTTPSuccess
-          info 'Uploaded deployment infos to Sentry'
+          info "Notified Sentry of new deployment: #{deploy_name}"
         else
           warn "Cannot notify sentry for new deployment. Response: #{response.code.inspect}: #{response.body}"
         end
@@ -69,8 +92,3 @@ namespace :sentry do
     end
   end
 end
-
-# 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
-# after 'deploy:published', 'sentry:notice_deployment'

data/test/capistrano/sentry_test.rb

@@ -1,11 +1,12 @@
-require 'test_helper'
+# frozen_string_literal: true
 
-class Capistrano::SentryTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil ::Capistrano::Sentry::VERSION
-  end
+require 'test_helper'
+require 'capistrano/sentry/version'
 
-  def test_it_does_something_useful
-    assert false
+module Capistrano
+  class SentryTest < Minitest::Test
+    def test_that_it_has_a_version_number
+      assert !::Capistrano::Sentry::VERSION.nil?
+    end
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'capistrano/sentry'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sentry
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.4.2
 platform: ruby
 authors:
 - Brice Texier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -56,25 +56,26 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: '10'
+description: Sentry release/deployment integration
 email:
 - brice@codeur.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -108,11 +109,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 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