groundskeeper-bitcore 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 449ebbff44fc02c29a84c6afeec8e74aa814baa0
-  data.tar.gz: f50934b12fead3af276632db62046856cad98dc3
+  metadata.gz: 1a6720f0999695735f6151edd0cb2cfa7ee92d7b
+  data.tar.gz: a954fe744717b6e1217cb23ab23cff635b604e97
 SHA512:
-  metadata.gz: 47dc880c5068e01a7063e675bf09b09102a39316e5b5e8a62c0f7e1c4c4657a053ca08190468ca75f0de44d4f0b5895137ff80b763e0a987ac7a319189956561
-  data.tar.gz: 90e21dbccd3ee4dc03a84b266bc27c4a3a1be996dd95e94e1354e40ded04b508d75e917b7a51c9f5c6d407d79eee781d9b35baab293f801a65a635bdd30021c0
+  metadata.gz: 1858a09df13187ccbc4056426e8bc62978bacdb27ec3f4b4f4550a29b1bdb702f2074627249396a136c51cb958ea8f652d4e135a469520d7a070d51b85ca23bf
+  data.tar.gz: 52e5565e52a32663117d4fe68227fc8e2822168d0c3987a7aaa5fae48dbb1fd82260676b130559e1feafd3c66ce2c0fe84517fb846602c85d1226d23044bae36

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 groundskeeper-*.gem
+.byebug_history

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.3.2 - 2018-11-14
+
+* GROUN-2 create the initial release of a Rails application (#80)
+* GROUN-12 add nicer formatting to the deploy steps (#78)
+* GROUN-6 display warning if tag is not found in repository
+* Specify the scopes for the Sentry auth token. (#77)
+
 ## 0.3.1 - 2018-11-09
 
 * GROUN-13 notify Sentry of a deployment to staging/production (#76)

data/README.md

@@ -31,8 +31,8 @@ one already.
 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/):
+For integration with Sentry, find or create your auth token
+[from here](https://sentry.io/settings/account/api/auth-tokens/) with the scopes `event:admin, event:read, member:read, org:read, project:read, project:releases, team:read`:
 
 ```bash
 export SENTRY_AUTH_TOKEN="auth-token"

data/lib/groundskeeper/application.rb

@@ -26,16 +26,20 @@ module Groundskeeper
       commands.release
     end
 
+    # :nocov:
     desc "predeploy", "create configuration files for the project"
     def predeploy
       commands.info
       commands.predeploy options
     end
+    # :nocov:
 
+    # :nocov:
     desc "deploy", "deploy the latest release"
     def deploy
       commands.info
       commands.deploy options
     end
+    # :nocov:
   end
 end

data/lib/groundskeeper/changelog.rb

@@ -37,7 +37,7 @@ module Groundskeeper
 
     def version_template(version, changes)
       ["\n", "## #{version} - #{date}", ""]
-        .concat(changes.map { |change| "* #{change}" })
+        .concat((changes || []).map { |change| "* #{change}" })
         .join("\n")
     end
   end

data/lib/groundskeeper/commands.rb

@@ -17,6 +17,7 @@ module Groundskeeper
     PRODUCTION = "production"
     DEFAULT_STAGE = STAGING
     TAG = "tag"
+    INITIAL_VERSION = "0.0.1"
 
     # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def self.build(console)
@@ -43,7 +44,7 @@ module Groundskeeper
         repository: repository,
         rubygems: Rubygems,
         sentry: sentry,
-        version_file: RailsVersion.new,
+        version_file: RailsVersion.build,
         website: website
       )
     end
@@ -80,6 +81,7 @@ module Groundskeeper
       @version_file = version_file
       @did_checkout_branch = false
       @did_push_to_remote = false
+      @current_step = 1
     end
     # rubocop:enable Metrics/MethodLength,Metrics/ParameterLists
 
@@ -102,27 +104,31 @@ module Groundskeeper
     end
     # rubocop:enable Metrics/AbcSize
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
     def release
-      return unrecognized_version unless version_file.exists?
+      is_initial_release = !version_file.exists?
+
       return missing_jira_credentials unless jira.credentials?
       return unless check_groundskeeper_version
+      return unrecognized_version unless version_file.rails?
+      version_file.create_initial_version! unless version_file.exists?
       pull_project_details
 
-      summarize_recent_commits
-      ask_next_version
+      summarize_recent_commits unless is_initial_release
+      ask_next_version(is_initial_release)
       ask_new_branch
       update_version_file
       update_changelog
-      commit_changes_and_tag
+      commit_changes_and_tag(is_initial_release)
       ask_create_jira_version
       ask_push_with_tags
-      ask_add_version_to_jira_issues
+      ask_add_version_to_jira_issues unless is_initial_release
       open_pull_request_page
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
 
+    # :nocov:
     def predeploy(options)
       return unrecognized_version unless version_file.exists?
       return unless check_groundskeeper_version
@@ -130,10 +136,12 @@ module Groundskeeper
 
       mina "predeploy", options
     end
+    # :nocov:
 
     # rubocop:disable Metrics/AbcSize
     def deploy(options)
       return unrecognized_version unless version_file.exists?
+      return unrecognized_tag unless tag_present_in_git?(ENV[TAG])
       return missing_jira_credentials unless jira.credentials?
       return unless check_groundskeeper_version
       pull_project_details
@@ -141,7 +149,7 @@ module Groundskeeper
       ENV["whenever"] = "1" if project.uses_whenever?
 
       mina "deploy", options
-      console.say("waiting for deployed application to restart...", :yellow)
+      announce_step "Wait for deployed application to restart"
       update_deployed_issues
       add_version_to_sentry
     end
@@ -153,10 +161,11 @@ module Groundskeeper
     attr_reader :changelog, :console, :git, :git_hub, :jira, :project,
                 :repository, :rubygems, :sentry, :version_file, :website
     # state
-    attr_reader :next_version, :recent_commits, :did_checkout_branch,
-                :did_push_to_remote
+    attr_reader :current_step, :did_checkout_branch, :did_push_to_remote,
+                :next_version, :recent_commits
 
     def mina(command, options)
+      announce_step "Run mina to deploy"
       cmd = String.new command
       cmd << " -s" if options[:simulate]
       cmd << " -v" if options[:verbose]
@@ -165,9 +174,11 @@ module Groundskeeper
     end
 
     def pull_project_details
-      console.say("Updating ~/.project_details from "\
-                  "#{git.remote_url('.project_details')}")
-      git.pull(".project_details")
+      @pull_project_details ||= begin
+        announce_step("Updating ~/.project_details from "\
+                      "#{git.remote_url('.project_details')}")
+        git.pull(".project_details")
+      end
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -206,13 +217,16 @@ module Groundskeeper
       console.say("")
     end
 
-    def ask_next_version
-      type = console.ask(
-        "Major, minor, or patch release?",
-        :cyan,
-        limited_to: %w[M m p]
-      )
-      @next_version = repository.bumped_semantic_version(type)
+    def ask_next_version(is_initial_release)
+      if is_initial_release
+        @next_version = INITIAL_VERSION
+      else
+        type = console.ask("Major, minor, or patch release?",
+                           :cyan,
+                           limited_to: %w[M m p])
+        @next_version = repository.bumped_semantic_version(type)
+      end
+
       console.say("next tag will be: #{next_version}", :green)
     end
 
@@ -234,13 +248,15 @@ module Groundskeeper
       console.say("# updated changelog", :green)
     end
 
-    def commit_changes_and_tag
-      git.add_update
+    # rubocop:disable Metrics/AbcSize
+    def commit_changes_and_tag(is_initial_release)
+      is_initial_release ? git.add_all : git.add_update
       git.commit(format(Repository::RELEASE_MESSAGE, next_version))
       console.say("# committed changes", :green)
       git.add_tag(next_version)
       console.say("# tagged", :green)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def ask_create_jira_version
       create_jira_version =
@@ -265,8 +281,10 @@ module Groundskeeper
 
       return unless add_version_to_jira_issues
 
+      # :nocov:
       jira.add_version_to_remote_issues(next_jira_version_name, issue_ids)
       console.say("# added version to Jira issues", :green)
+      # :nocov:
     end
 
     def next_jira_version_name
@@ -274,12 +292,24 @@ module Groundskeeper
     end
 
     def add_version_to_sentry
+      announce_step "Add release to Sentry and mark deployed"
       sentry.create_release(ENV[TAG])
       sentry.associate_commits(ENV[TAG])
       sentry.deploy(ENV[TAG], self.class.stage)
       console.say("# added version to Sentry", :green)
     end
 
+    def tag_present_in_git?(tag)
+      git.list_tags.include? tag
+    end
+
+    def unrecognized_tag
+      console.say(
+        "Tag not found, try again with an existing tag.",
+        :red
+      )
+    end
+
     def unrecognized_version
       console.say(
         "Unable to find version file, is this a Rails application?",
@@ -307,22 +337,29 @@ module Groundskeeper
     def run_mina(arguments)
       command = "mina #{arguments} -f #{RAKEFILE}"
       Open3.popen3(command) do |_stdout, stderr, _status, _thread|
+        # :nocov:
         # rubocop:disable Lint/AssignmentInCondition
         while line = stderr.gets
           puts line
         end
         # rubocop:enable Lint/AssignmentInCondition
+        # :nocov:
       end
     end
 
     def update_deployed_issues
+      announce_step(
+        "Check deployed version at #{website.uri}/#{Website::VERSION_PATH}"
+      )
       deployed_version = website.version
 
       if deployed_version == ENV[TAG]
         console.say("# deployment successful", :green)
         transition_remote_issues deployed_version
       else
+        # :nocov:
         console.say("something went wrong", :red)
+        # :nocov:
       end
     end
 
@@ -331,13 +368,20 @@ module Groundskeeper
       deployed_issues = jira.fetch_issues_by_fix_version(version_name)
       action =
         self.class.stage == PRODUCTION ? Jira::DELIVER : Jira::DEPLOY_TO_STAGING
-      console.say(
-        "transitioning deployed issues in Jira: " \
-          "#{action} #{deployed_issues.join(', ')}",
-        :yellow
+      announce_step(
+        "Transitioning deployed issues in Jira: " \
+        "#{action} #{deployed_issues.join(', ')}"
       )
       jira.transition_remote_issues(action, deployed_issues)
     end
+
+    def announce_step(message)
+      console.say(">>>", :magenta)
+      console.say(">>> #{@current_step}. #{message}", :magenta)
+      console.say(">>>", :magenta)
+      console.say("")
+      @current_step += 1
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/groundskeeper/document.rb

@@ -10,7 +10,15 @@ module Groundskeeper
     end
 
     def exists?
-      File.exist? path
+      File.exist?(path)
+    end
+
+    def file?
+      File.file?(path)
+    end
+
+    def make_parent_directory!
+      Dir.mkdir(File.dirname(path))
     end
 
     # Returns the first captured expression or nil if it is not found.
@@ -47,7 +55,7 @@ module Groundskeeper
     end
 
     def read
-      return "" unless exists?
+      return "" unless exists? && file?
 
       File.binread(path)
     end

data/lib/groundskeeper/git.rb

@@ -15,6 +15,7 @@ module Groundskeeper
     LATEST_CHANGES = "log %s..HEAD --oneline"
     CREATE_AND_CHECKOUT_BRANCH = "checkout -b %s"
     ADD_UPDATE = "add -u"
+    ADD_ALL = "add ."
     COMMIT = "commit -m \"%s\""
     ADD_TAG = "tag %s"
     PUSH_HEAD_WITH_TAGS = "push origin head --tags"
@@ -78,6 +79,10 @@ module Groundskeeper
       git.execute(ADD_UPDATE)
     end
 
+    def add_all
+      git.execute(ADD_ALL)
+    end
+
     def commit(message)
       git.execute(format(COMMIT, message))
     end

data/lib/groundskeeper/jira.rb

@@ -35,18 +35,23 @@ module Groundskeeper
         )
       end
 
+      # :nocov:
       def create_version(name:, prefix:)
         client.Version
               .build
               .save(name: name, project: prefix)
       end
+      # :nocov:
 
+      # :nocov:
       def add_version_to_issue(issue_id:, version_name:)
         client.Issue
               .find(issue_id)
               .save(update: { fixVersions: [{ add: { name: version_name } }] })
       end
+      # :nocov:
 
+      # :nocov:
       def transition_issue(issue_id:, transition_id:)
         client.Issue
               .find(issue_id)
@@ -54,7 +59,9 @@ module Groundskeeper
               .build
               .save(transition: { id: transition_id })
       end
+      # :nocov:
 
+      # :nocov:
       def fetch_issues_by_fix_version(version:)
         search_path = "/rest/api/2/search"
         query = "fixVersion = \"#{version}\""
@@ -63,6 +70,7 @@ module Groundskeeper
 
         JSON.parse(response)["issues"].map { |issue| issue["key"] }
       end
+      # :nocov:
     end
 
     def self.build(prefix)
@@ -113,8 +121,10 @@ module Groundskeeper
       end
     end
 
+    # :nocov:
     def fetch_issues_by_fix_version(version)
       client.fetch_issues_by_fix_version(version: version)
     end
+    # :nocov:
   end
 end

data/lib/groundskeeper/project.rb

@@ -32,11 +32,13 @@ module Groundskeeper
       )
     end
 
+    # :nocov:
     def self.available_applications
       yaml = Document.new(DETAILS_PATH).read
       projects = YAML.safe_load(yaml) || {}
       projects.keys.join(", ")
     end
+    # :nocov:
 
     def initialize(projects_yaml:, servers_yaml:, repository_name:)
       projects = YAML.safe_load(projects_yaml) || {}
@@ -61,54 +63,77 @@ module Groundskeeper
       details.dig(FULL_DNS_KEY, stage.to_s) || ""
     end
 
+    # :nocov:
     def db_env_variables(stage)
       details.dig(DB_ENV_VARIABLES_KEY, stage.to_s) || ""
     end
+    # :nocov:
 
+    # :nocov:
     def rvm_ruby_version
       details[RVM_RUBY_VERSION_KEY] || ""
     end
+    # :nocov:
 
+    # :nocov:
     def sentry_dsn
       details[SENTRY_DSN_KEY] || ""
     end
+    # :nocov:
 
+    # :nocov:
     def sentry_public_dsn
       details[SENTRY_PUBLIC_DSN_KEY] || ""
     end
+    # :nocov:
 
     def sentry_project
       details[SENTRY_PROJECT_KEY] || ""
     end
 
+    # :nocov:
     def ssl_certificate_file(stage)
       details.dig(SSL_CERTIFICATE_FILE_KEY, stage.to_s) || ""
     end
+    # :nocov:
 
+    # :nocov:
     def ssl_certificate_chain_file(stage)
       details.dig(SSL_CERTIFICATE_CHAIN_FILE_KEY, stage.to_s) || ""
     end
+    # :nocov:
 
+    # :nocov:
     def ssl_certificate_key_file(stage)
       details.dig(SSL_CERTIFICATE_KEY_FILE_KEY, stage.to_s) || ""
     end
+    # :nocov:
 
+    # :nocov:
     def uses_whenever?
       details[WHENEVER_KEY] == true
     end
+    # :nocov:
 
+    # :nocov:
     def server_config(stage)
       servers[full_dns(stage)]
     end
+    # :nocov:
 
+    # :nocov:
     def repo_url
       "git@github.com:#{source_control_username}/#{repo_name}.git"
     end
+    # :nocov:
 
+    # :nocov:
     def deploy_to
       "/var/www/apps/#{repo_name}"
     end
+    # :nocov:
 
+    # :nocov:
     def tags
       api_url = "https://api.github.com/repos/" \
                 "#{source_control_username}/#{repo_name}/tags"
@@ -121,5 +146,6 @@ module Groundskeeper
       end
       response.map { |h| h["name"] }
     end
+    # :nocov:
   end
 end

data/lib/groundskeeper/rails_version.rb

@@ -4,15 +4,48 @@ module Groundskeeper
   # The `version.rb` file in an application.
   class RailsVersion
     APPLICATION_CONFIG_FILE = "%sconfig/application.rb"
+    INITIAL_VERSION = "0.0.0"
     MODULE_NAME_EXPRESSION = /module (\w+)/
-    VERSION_FILE = "%slib/%s/version.rb"
+    NAMESPACE_FILE = "%slib/%s.rb"
+    MODULE_DIRECTORY = "%slib/%s"
+    VERSION_FILE = "#{MODULE_DIRECTORY}/version.rb"
     VERSION_EXPRESSION = /(?<=VERSION = ")([^"]+)(?=")/
 
-    attr_reader :relative_path, :module_file, :version_file
+    attr_reader :config_file, :namespace_file, :project_name, :relative_path,
+                :version_file
 
-    def initialize(relative_path = "")
+    # rubocop:disable Metrics/MethodLength
+    def self.build(relative_path = "")
+      config_file_path = format(APPLICATION_CONFIG_FILE, relative_path)
+      config_file = Groundskeeper::Document.new(config_file_path)
+      project_name = config_file.match(MODULE_NAME_EXPRESSION)
+      folder_namespace = StringUtils.underscore(project_name)
+      namespace_file_path =
+        format(NAMESPACE_FILE, relative_path, folder_namespace)
+      version_file_path = format(VERSION_FILE, relative_path, folder_namespace)
+
+      new(
+        relative_path,
+        project_name: project_name,
+        config_file: config_file,
+        namespace_file: Groundskeeper::Document.new(namespace_file_path),
+        version_file: Groundskeeper::Document.new(version_file_path)
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def initialize(
+      relative_path = "",
+      project_name: "",
+      config_file: nil,
+      namespace_file:,
+      version_file: nil
+    )
       @relative_path = relative_path
-      find_version_file
+      @project_name = project_name
+      @config_file = config_file || find_config_file
+      @namespace_file = namespace_file
+      @version_file = version_file || find_version_file
     end
 
     def current_version
@@ -23,40 +56,61 @@ module Groundskeeper
       version_file.gsub_file VERSION_EXPRESSION, value
     end
 
+    def rails?
+      config_file.exists?
+    end
+
     def exists?
       version_file.exists?
     end
 
+    # rubocop:disable Metrics/MethodLength
+    def create_initial_version!
+      version_file.make_parent_directory!
+      version_file.write_file(
+        <<~RB
+          # frozen_string_literal: true
+
+          # Version string.
+          module #{project_name}
+            VERSION = "#{INITIAL_VERSION}"
+          end
+        RB
+      )
+      namespace_file.write_file(
+        <<~RB
+          # frozen_string_literal: true
+
+          require_relative "./#{folder_namespace}/version"
+
+          # nodoc
+          module #{project_name}
+          end
+        RB
+      )
+    end
+    # rubocop:enable Metrics/MethodLength
+
     private
 
-    def find_module_file
-      @module_file = Groundskeeper::Document.new(module_file_path)
+    def find_config_file
+      @config_file = Groundskeeper::Document.new(config_file_path)
     end
 
     def find_version_file
-      find_module_file
       @version_file = Groundskeeper::Document.new(version_file_path)
     end
 
-    def module_file_path
+    def config_file_path
       format APPLICATION_CONFIG_FILE, relative_path
     end
 
     def version_file_path
-      format VERSION_FILE, relative_path, project_namespace
+      format VERSION_FILE, relative_path, folder_namespace
     end
 
-    def project_namespace
-      underscore(module_file.match(MODULE_NAME_EXPRESSION))
-    end
-
-    def underscore(word)
-      return "" unless word.respond_to?(:gsub)
-
-      word
-        .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
-        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-        .downcase
+    def folder_namespace
+      StringUtils.underscore(config_file.match(MODULE_NAME_EXPRESSION))
     end
   end
 end

data/lib/groundskeeper/repository.rb

@@ -33,6 +33,7 @@ module Groundskeeper
       git.status.include? UNSTAGED_CHANGES
     end
 
+    # :nocov:
     def status
       @status ||= begin
         git.fetch
@@ -40,6 +41,7 @@ module Groundskeeper
         git.status
       end
     end
+    # :nocov:
 
     def changes_since_latest_tag
       git

data/lib/groundskeeper/rubygems.rb

@@ -7,11 +7,13 @@ module Groundskeeper
   class Rubygems
     VERSION_API = "https://rubygems.org/api/v1/versions/"
 
+    # :nocov:
     def self.latest_groundskeeper_version
       out = `curl #{VERSION_API}groundskeeper-bitcore/latest.json 2>/dev/null`
       response = JSON.parse(out)
 
       response["version"]
     end
+    # :nocov:
   end
 end

data/lib/groundskeeper/semantic_version.rb

@@ -10,11 +10,13 @@ module Groundskeeper
 
     attr_reader :major, :minor, :patch
 
+    # :nocov:
     def self.build(version)
       return version if version.is_a?(SemanticVersion)
 
       new(version)
     end
+    # :nocov:
 
     def initialize(version)
       @major, @minor, @patch = version.split(".").map(&:to_i)

data/lib/groundskeeper/string_utils.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Groundskeeper
+  # Helpers for strings.
+  module StringUtils
+    def self.underscore(word)
+      return "" unless word.respond_to?(:gsub)
+
+      word
+        .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .downcase
+    end
+  end
+end

data/lib/groundskeeper/version.rb

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

data/lib/groundskeeper/website.rb

@@ -13,8 +13,10 @@ module Groundskeeper
       @uri = uri
     end
 
+    # :nocov:
     def version
       URI.parse("#{uri}/#{VERSION_PATH}").read
     end
+    # :nocov:
   end
 end

data/lib/groundskeeper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groundskeeper-bitcore
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - BIT Core
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain:
 - certs/ericcf.pem
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jira-ruby
@@ -182,6 +182,7 @@ files:
 - lib/groundskeeper/rubygems.rb
 - lib/groundskeeper/semantic_version.rb
 - lib/groundskeeper/sentry.rb
+- lib/groundskeeper/string_utils.rb
 - lib/groundskeeper/version.rb
 - lib/groundskeeper/website.rb
 - servers.yml