groundskeeper-bitcore 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4203efc4a4b827dbe8af6af07d0e4cc356a224c1
-  data.tar.gz: 0a989a82b8d1840d2e2b83c66570ecf7cb41788b
+  metadata.gz: 5cf64d2506cf32911c7e1ab501f47c1252448101
+  data.tar.gz: 0f549714b3219739a4bec6d42742ebbf57a09159
 SHA512:
-  metadata.gz: 75133cb91f0ab49bf284a0fef6c4588b8112f9d8b5ed5fe743d2a26811dcae93a2132c8c64e1003524b9be89cfcc44eaa9e144f90fb2bd01deedafe8075807fe
-  data.tar.gz: d25f98d3b312eb974ae842577a6dd37f922c99ff3eb82c9ad102de672b45aa73d9bef5da8aa2b601a51a5eea0690c480b6927f408636ef17efed4841dc76cbca
+  metadata.gz: ddc494c4bf9437239d7a4fe37bea74bbf36df700faa6ec0bd6f418d9b9ec7837b391b21e565e73749a95733784d990cca96f104339a7523c428f880cbccaed04
+  data.tar.gz: c43ce1f114abd12e195ba268c155e041b949813a920c5d7e94b799fdfaa497bdc73c31d38ea0e8f7779b79954f63e8560b1d13ad2e7b3dc67fb56587b5dd3b2d

data/README.md

@@ -23,12 +23,24 @@ export JIRA_PASSWORD="my-password"
 export JIRA_SITE="https://cbit123.atlassian.net"
 ```
 
-Additionally, you need to add a GitHub API Token with `repo` scope to your `bash_profile`. You can create one [here](https://github.com/settings/tokens) if you don't have one already.
+You also need to add a GitHub API Token with `repo` scope to your `bash_profile`.
+You can create one [here](https://github.com/settings/tokens) if you don't have
+one already.
 
 ```bash
 export GITHUB_API_TOKEN="my-github-api-token"
 ```
 
+For integration with Sentry, find and add your auth token
+[from here](https://sentry.io/settings/account/api/auth-tokens/):
+
+```bash
+export SENTRY_AUTH_TOKEN="auth-token"
+export SENTRY_ORG=cbits
+```
+
+Then you will need to [install/update the Sentry CLI](https://docs.sentry.io/learn/cli/installation/).
+
 Jira integration also depends on a repository that contains metadata for
 projects. Clone it as follows:
 

data/groundskeeper.gemspec

@@ -41,4 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rubocop", "~> 0.49.1"
   spec.add_development_dependency "simplecov", "~> 0.14"
+  spec.add_development_dependency "byebug"
 end

data/lib/groundskeeper.rb

@@ -12,6 +12,7 @@ require "groundskeeper/rails_version"
 require "groundskeeper/repository"
 require "groundskeeper/rubygems"
 require "groundskeeper/semantic_version"
+require "groundskeeper/sentry"
 require "groundskeeper/version"
 require "groundskeeper/website"
 

data/lib/groundskeeper/commands.rb

@@ -18,14 +18,20 @@ module Groundskeeper
     DEFAULT_STAGE = STAGING
     TAG = "tag"
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def self.build(console)
       repository = Repository.new
       project = Project.build(repository.name)
+      deploy_url = "https://#{project.full_dns(stage)}"
+      website = Website.new(deploy_url)
       git_hub = GitHub.build(
         username: project.source_control_username,
         repository_name: repository.name
       )
+      sentry = Sentry.build(
+        project_name: project.sentry_project,
+        version_prefix: repository.name
+      )
 
       new(
         changelog: Changelog.build,
@@ -36,10 +42,16 @@ module Groundskeeper
         project: project,
         repository: repository,
         rubygems: Rubygems,
-        version_file: RailsVersion.new
+        sentry: sentry,
+        version_file: RailsVersion.new,
+        website: website
       )
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+
+    def self.stage
+      ENV[STAGE] == PRODUCTION ? PRODUCTION : DEFAULT_STAGE
+    end
 
     # rubocop:disable Metrics/MethodLength,Metrics/ParameterLists
     def initialize(
@@ -51,6 +63,8 @@ module Groundskeeper
       project: nil,
       repository: nil,
       rubygems: nil,
+      sentry: nil,
+      website: nil,
       version_file:
     )
       @changelog = changelog
@@ -61,17 +75,19 @@ module Groundskeeper
       @project = project
       @repository = repository
       @rubygems = rubygems
+      @sentry = sentry
+      @website = website
       @version_file = version_file
       @did_checkout_branch = false
       @did_push_to_remote = false
     end
     # rubocop:enable Metrics/MethodLength,Metrics/ParameterLists
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
     def info
       return unrecognized_version unless version_file.exists?
-
       return unless check_groundskeeper_version
+      pull_project_details
 
       announce_latest_tag
       console.say(
@@ -84,12 +100,14 @@ module Groundskeeper
         :yellow
       )
     end
+    # rubocop:enable Metrics/AbcSize
 
     # rubocop:disable Metrics/AbcSize
     def release
       return unrecognized_version unless version_file.exists?
       return missing_jira_credentials unless jira.credentials?
       return unless check_groundskeeper_version
+      pull_project_details
 
       summarize_recent_commits
       ask_next_version
@@ -108,27 +126,32 @@ module Groundskeeper
     def predeploy(options)
       return unrecognized_version unless version_file.exists?
       return unless check_groundskeeper_version
+      pull_project_details
 
       mina "predeploy", options
     end
 
+    # rubocop:disable Metrics/AbcSize
     def deploy(options)
       return unrecognized_version unless version_file.exists?
       return missing_jira_credentials unless jira.credentials?
       return unless check_groundskeeper_version
+      pull_project_details
 
       ENV["whenever"] = "1" if project.uses_whenever?
 
       mina "deploy", options
       console.say("waiting for deployed application to restart...", :yellow)
       update_deployed_issues
+      add_version_to_sentry
     end
+    # rubocop:enable Metrics/AbcSize
 
     private
 
     # collaborators
     attr_reader :changelog, :console, :git, :git_hub, :jira, :project,
-                :repository, :rubygems, :version_file
+                :repository, :rubygems, :sentry, :version_file, :website
     # state
     attr_reader :next_version, :recent_commits, :did_checkout_branch,
                 :did_push_to_remote
@@ -141,6 +164,12 @@ module Groundskeeper
       run_mina cmd
     end
 
+    def pull_project_details
+      console.say("Updating ~/.project_details from "\
+                  "#{git.remote_url('.project_details')}")
+      git.pull(".project_details")
+    end
+
     def check_groundskeeper_version
       console.say("Groundskeeper version #{Groundskeeper::VERSION}\n\n", :bold)
       latest_version = rubygems.latest_groundskeeper_version
@@ -239,6 +268,12 @@ module Groundskeeper
       "#{repository.name} #{next_version}"
     end
 
+    def add_version_to_sentry
+      sentry.create_release(ENV[TAG])
+      sentry.associate_commits(ENV[TAG])
+      console.say("# added version to Sentry", :green)
+    end
+
     def unrecognized_version
       console.say(
         "Unable to find version file, is this a Rails application?",
@@ -275,8 +310,7 @@ module Groundskeeper
     end
 
     def update_deployed_issues
-      deployed_url = "https://#{project.full_dns(stage)}"
-      deployed_version = Website.new(deployed_url).version
+      deployed_version = website.version
 
       if deployed_version == ENV[TAG]
         console.say("# deployment successful", :green)
@@ -286,14 +320,11 @@ module Groundskeeper
       end
     end
 
-    def stage
-      ENV[STAGE] == PRODUCTION ? PRODUCTION : DEFAULT_STAGE
-    end
-
     def transition_remote_issues(version)
       version_name = "#{repository.name} #{version}"
       deployed_issues = jira.fetch_issues_by_fix_version(version_name)
-      action = stage == PRODUCTION ? Jira::DELIVER : Jira::DEPLOY_TO_STAGING
+      action =
+        self.class.stage == PRODUCTION ? Jira::DELIVER : Jira::DEPLOY_TO_STAGING
       console.say(
         "transitioning deployed issues in Jira: " \
           "#{action} #{deployed_issues.join(', ')}",

data/lib/groundskeeper/git.rb

@@ -18,6 +18,8 @@ module Groundskeeper
     COMMIT = "commit -m \"%s\""
     ADD_TAG = "tag %s"
     PUSH_HEAD_WITH_TAGS = "push origin head --tags"
+    PULL = "-C #{Dir.home}/%s pull"
+    REMOTE_URL = "-C #{Dir.home}/%s config --get remote.origin.url"
 
     attr_reader :git
 
@@ -87,5 +89,13 @@ module Groundskeeper
     def push_with_tags
       git.execute(PUSH_HEAD_WITH_TAGS)
     end
+
+    def pull(name)
+      git.execute(format(PULL, name))
+    end
+
+    def remote_url(name)
+      git.execute(format(REMOTE_URL, name))
+    end
   end
 end

data/lib/groundskeeper/project.rb

@@ -18,6 +18,7 @@ module Groundskeeper
     DB_ENV_VARIABLES_KEY = "db_env_variables"
     SENTRY_DSN_KEY = "sentry_dsn"
     SENTRY_PUBLIC_DSN_KEY = "sentry_public_dsn"
+    SENTRY_PROJECT_KEY = "sentry_project"
     SSL_CERTIFICATE_FILE_KEY = "SSLCertificateFile"
     SSL_CERTIFICATE_CHAIN_FILE_KEY = "SSLCertificateChainFile"
     SSL_CERTIFICATE_KEY_FILE_KEY = "SSLCertificateKeyFile"
@@ -76,6 +77,10 @@ module Groundskeeper
       details[SENTRY_PUBLIC_DSN_KEY] || ""
     end
 
+    def sentry_project
+      details[SENTRY_PROJECT_KEY] || ""
+    end
+
     def ssl_certificate_file(stage)
       details.dig(SSL_CERTIFICATE_FILE_KEY, stage.to_s) || ""
     end

data/lib/groundskeeper/sentry.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Groundskeeper
+  # Wraps Sentry CLI executable.
+  class Sentry
+    COMMAND = "sentry-cli"
+    # sentry-cli arguments
+    RELEASE = "releases new -p %<project>s \"%<version>s\""
+    ASSOCIATE = "releases set-commits --auto \"%<version>s\""
+
+    attr_reader :sentry, :project_name, :version_prefix
+
+    # Wraps the "sentry-cli" shell command.
+    class Executable
+      def execute(arguments)
+        `#{COMMAND} #{arguments}`
+      end
+    end
+
+    def self.build(project_name:, version_prefix:)
+      new(
+        sentry: Executable.new,
+        project_name: project_name,
+        version_prefix: version_prefix
+      )
+    end
+
+    def initialize(sentry:, project_name:, version_prefix:)
+      @sentry = sentry
+      @project_name = project_name
+      @version_prefix = version_prefix
+    end
+
+    # Notify Sentry about release
+    def create_release(version)
+      name = "#{version_prefix} #{version}"
+
+      sentry.execute(format(RELEASE, project: project_name, version: name))
+    end
+
+    # Associate commits with the release
+    def associate_commits(version)
+      name = "#{version_prefix} #{version}"
+
+      sentry.execute(format(ASSOCIATE, version: name))
+    end
+  end
+end

data/lib/groundskeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Groundskeeper
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groundskeeper-bitcore
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - BIT Core
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain:
 - certs/ericcf.pem
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jira-ruby
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - ericcf@northwestern.edu
@@ -167,6 +181,7 @@ files:
 - lib/groundskeeper/repository.rb
 - lib/groundskeeper/rubygems.rb
 - lib/groundskeeper/semantic_version.rb
+- lib/groundskeeper/sentry.rb
 - lib/groundskeeper/version.rb
 - lib/groundskeeper/website.rb
 - servers.yml