robopigeon 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f0eb12780af404e3c5d222d9468804f0b7aec1aeef45407980ee90b578d66f
-  data.tar.gz: c9947148df1def3093400399632b4fb7225be2c679fd141841ceae2a4b49e908
+  metadata.gz: 25d50f00dc30aa78bd9389cee8da7d93aa04920e4db5c10433f39c2df4d97b0f
+  data.tar.gz: c0f86cfe9dc63bb753d4ee5e88cfe16512fce547fcdb649ffe4776282c3162dd
 SHA512:
-  metadata.gz: f8d9516e989b6cbae9a5bd5c6fe41224569be78689288ce35e322cdb15dc35549a706bd37b29e0b3c11440ce7ca4b92a73130a27edb81e9b3579d44ca7661b49
-  data.tar.gz: 86704bdca6792091a21231d53ee8aa8c3d5175c77a118b796baf84d05a1aa91c7907b09998b8fe02233863d908654d8e598bd243fd18df897ca7f88b2ec5241a
+  metadata.gz: 9f980108a24e6e081f073e9747efca1fcb4cb14f776aa911cb4a60c769529401abf140b0f09de6c68208f1d78dde56a6ea8f8ae899b8ab3d943676be34bf8a80
+  data.tar.gz: 94b3b6a2f9631eb610ddfb2bf13fc8f885d3962d65a5dbdcfeb7c56ad44bbdf25d298db7fdf7b08ad9b3cd463cabc65a9c88c3310fd7a0b3a21960be94af7e0e

data/.version

@@ -1 +1 @@
-0.2.0
+0.3.0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.3.0 (2019-04-8)
+
+### Added
+
+- Gitlab Helper to check if files had changed since deploy
+- Gitlab Helper to get a link to a diff since that last deployment
+- Init adds an rspec with an example to test your jobs
+
+### Changed
+
+- Tickets since deploy takes an optional argument to specify a regex match
+- Creating a ticket writes out a file called 'last_created_jira_ticket' with the ticket id in it
+
 ## 0.2.0 (2019-03-29)
 
 ### Added (3 changes)

data/README.md

@@ -94,6 +94,11 @@ Jenkins
 Extensions
 - [x] Create basic example dsl extension gem template
 
+### Features for future version
+
+Variables
+- [ ] Add a variable configuration block that will inject them into all of the job contexts
+
 PagerDuty
 - [ ] Get current oncall user from pagerduty api
 
@@ -106,8 +111,6 @@ Changelog
 - [ ] Helpers provide changes since last deployment
 - [ ] Changelog yaml front matter informs risk of change
 
-### Features for future version
-
 GitLab
 - [ ] Wait for a merge request to be ready to merge
 - [ ] Kick off a pipeline

data/lib/robopigeon/dsl/initial_jobs.rb

@@ -1,5 +1,8 @@
 module RoboPigeon::Dsl::InitialJobs
   INITIAL_FILE = "#{File.dirname(__FILE__)}/../resources/initial_robopigeon.rb".freeze
+  INITIAL_TEST = "#{File.dirname(__FILE__)}/../../../spec/initial_robopigeon_spec.rb".freeze
+  TARGET_TEST = 'spec/robopigeon_spec.rb'.freeze
+
   # Used to pull in environment variables for things that are mostly set via dsl
   def base
     slack do
@@ -19,6 +22,7 @@ module RoboPigeon::Dsl::InitialJobs
       desc: 'Initialize a new robopigeon project',
       action: proc do
         FileUtils.cp(INITIAL_FILE, RoboPigeon::DEFAULT_FILE)
+        FileUtils.cp(INITIAL_TEST, TARGET_TEST)
       end
     }
   end

data/lib/robopigeon/extend/template.rb

@@ -17,7 +17,7 @@ module RoboPigeon::Extensions
 
     def render_to(path)
       cwd = FileUtils.pwd
-      base = File.expand_path("#{path}/robopigeon-#{name}")
+      base = File.expand_path("#{path}/robopigeon_#{name}")
       FileUtils.cd "#{TEMPLATE_PATH}/#{template}"
       FileUtils.mkdir_p base.to_s
       Dir.glob('{**{,/*/**},.*}') do |file|

data/lib/robopigeon/extend/templates/default/{Gemfile → Gemfile.erb}

@@ -3,4 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in robopigeon.gemspec
 gemspec
 
-gem 'robopigeon', path: '../robopigeon'
+<% if ENV['ROBOPIGEON_TEST'] %>
+  gem 'robopigeon', path: '../robopigeon'
+<% end %>

data/lib/robopigeon/extend/templates/default/README.erb.md

@@ -1,4 +1,4 @@
-# RoboPigeon-<%= extension_name_upper %>
+# RoboPigeon <%= extension_name_upper %>
 
 TODO: Add a description of what dsls/helpers this adds.
 
@@ -9,7 +9,7 @@ This Gem is developed against ruby 2.5, but is tested in CI against the latest v
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'robopigeon-<%= extension_name_lower %>'
+gem 'robopigeon_<%= extension_name_lower %>'
 ```
 
 And then execute:
@@ -18,7 +18,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install robopigeon-<%= extension_name_lower %>
+    $ gem install robopigeon_<%= extension_name_lower %>
 
 ## Usage
 
@@ -32,4 +32,4 @@ Then run `bundle exec rspec` to run the tests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/{gitlab_username}/robopigeon-<%= extension_name_lower %>.
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/{gitlab_username}/robopigeon_<%= extension_name_lower %>.

data/lib/robopigeon/extend/templates/default/lib/{robopigeon-extension.erb.rb → robopigeon_extension.erb.rb}

@@ -1,6 +1,6 @@
-require 'robopigeon-<%= extension_name_lower %>/helper_dsl'
-require 'robopigeon-<%= extension_name_lower %>/dsl'
-require 'robopigeon-<%= extension_name_lower %>/version'
+require 'robopigeon_<%= extension_name_lower %>/helper_dsl'
+require 'robopigeon_<%= extension_name_lower %>/dsl'
+require 'robopigeon_<%= extension_name_lower %>/version'
 
 module RoboPigeon::Dsl
   module Helpers

data/lib/robopigeon/extend/templates/default/{robopigeon-extension.erb.gemspec → robopigeon_extension.erb.gemspec}

@@ -1,9 +1,9 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'robopigeon-<%= extension_name_lower %>/version'
+require 'robopigeon_<%= extension_name_lower %>/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'robopigeon-<%= extension_name_lower %>'
+  spec.name          = 'robopigeon_<%= extension_name_lower %>'
   spec.version       = RoboPigeon::<%= extension_name_upper %>::VERSION
   spec.authors       = ['<%= user_name %>']
   spec.email         = ['<%= user_email %>']

data/lib/robopigeon/extend/templates/default/spec/spec_helper.erb.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'bundler/setup'
 require 'robopigeon'
-require 'robopigeon-<%= extension_name_lower %>'
+require 'robopigeon_<%= extension_name_lower %>'
 require 'pry'
 
 RSpec.configure do |config|

data/lib/robopigeon/git/helper_dsl.rb

@@ -31,6 +31,19 @@ module RoboPigeon::Dsl
         get_merge_data[:target]
       end
 
+      RoboPigeon::Documentarian.add_command(
+        'changed_since?',
+        block: ['helpers'],
+        params: [
+          { name: 'ref', type: 'String', example: 'd72f9e3808a9e6d59ac88e3d56b81f073c5cca37', desc: 'Git ref to compare to' },
+          { name: 'files', type: 'String', example: 'build.gradle', desc: 'file to check if changed' }
+        ],
+        desc: 'target branch in the last merge commit'
+      )
+      def changed_since?(ref, *files)
+        `git diff #{ref} -- #{files.join(' ')}`
+      end
+
       private
 
       def merge_commit_subject

data/lib/robopigeon/gitlab/helper_dsl.rb

@@ -15,6 +15,12 @@ module RoboPigeon::Dsl
         dep.ref
       end
 
+      RoboPigeon::Documentarian.add_command('deployment_diff_link', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get a link to the changes between the last deploy and the current ref')
+      def deployment_diff_link(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        "#{ENV['CI_PROJECT_URL']}/compare/#{dep.ref}...#{ENV['CI_COMMIT_TAG']}"
+      end
+
       RoboPigeon::Documentarian.add_command('deployment_shortlog', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get a shortlog of changes between head and the specified environment')
       def deployment_shortlog(environment)
         dep = RoboPigeon::GitLab::Client.get_deployment(environment)
@@ -27,17 +33,25 @@ module RoboPigeon::Dsl
         dep.deployable.finished_at
       end
 
-      RoboPigeon::Documentarian.add_command('deployment_git_log_jira_tickets',
-                                            block: ['helpers'],
-                                            params: [
-                                              { name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' },
-                                              { name: 'project_key', type: 'String', desc: 'the project key to search history for', example: 'TIC' }
-                                            ],
-                                            desc: 'returns a list of jira tickets for the given project key in history since the deployment')
-      def tickets_in_log_since_deployment_to(environment, _project)
+      RoboPigeon::Documentarian.add_command('environment_link', block: ['helpers'], params: [{ name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' }], desc: 'get a link to the environment by name')
+      def environment_link(environment)
+        dep = RoboPigeon::GitLab::Client.get_deployment(environment)
+        "#{ENV['CI_PROJECT_URL']}/environments/#{dep.environment.id}"
+      end
+
+      RoboPigeon::Documentarian.add_command(
+        'deployment_git_log_jira_tickets',
+        block: ['helpers'],
+        params: [
+          { name: 'environment', type: 'String', desc: 'the name of a gitlab operations environment', example: 'production' },
+          { name: 'project_key', type: 'String', desc: 'the project key to search history for', example: 'TIC' }
+        ],
+        desc: 'returns a list of jira tickets for the given project key in history since the deployment'
+      )
+      def tickets_in_log_since_deployment_to(environment, matcher=/[A-Za-z]+-\d+/)
         dep = RoboPigeon::GitLab::Client.get_deployment(environment)
         log = `git log #{dep.sha}..`
-        log.scan(/[A-Za-z]+-\d+/)
+        log.scan(matcher)
       end
     end
   end

data/lib/robopigeon/jira/client.rb

@@ -2,6 +2,7 @@ module RoboPigeon::Jira
   class Client
     @enabled = true
     @api_key = ENV['JIRA_TOKEN']
+    @last_created_ticket = File.read('last_created_jira_ticket') if File.exist?('last_created_jira_ticket')
 
     class << self
       attr_accessor :api_key, :api_url, :enabled, :last_created_ticket

data/lib/robopigeon/jira/ticket.rb

@@ -49,6 +49,7 @@ module RoboPigeon::Jira
       begin
         self.ticket = JSON.parse(response.body).fetch('key')
         RoboPigeon::Jira::Client.last_created_ticket = ticket
+        File.write('last_created_jira_ticket', ticket)
       rescue KeyError
         raise RoboPigeon::Jira::RequiredFieldNotSet, "Response from JIRA did not contain new issue key: #{response.body}"
       end
@@ -80,10 +81,6 @@ module RoboPigeon::Jira
       self.reporter = user['name']
     end
 
-    def description_from_template(_file)
-      self.description = 'Content from an erb template'
-    end
-
     def set_field(name, value)
       require_field(:issue_type)
       request_path = "#{ISSUE_PATH}/createmeta?projectKeys=#{project}&expand=projects.issuetypes.fields"

data/robopigeon.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + ['spec/initial_robopigeon_spec.rb']
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/spec/initial_robopigeon_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'robopigeon'
+
+describe 'robopigeon.rb file' do
+  subject { RoboPigeon::Dsl::Root.new }
+  context 'version' do
+    it 'should print the verison to standard out' do
+      expect { subject.run('version') }.to output(RoboPigeon::VERSION).to_stdout
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robopigeon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Ives
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -268,13 +268,13 @@ files:
 - lib/robopigeon/extend/templates/default/.gitlab-ci.yml
 - lib/robopigeon/extend/templates/default/.rubocop.yml
 - lib/robopigeon/extend/templates/default/.version
-- lib/robopigeon/extend/templates/default/Gemfile
+- lib/robopigeon/extend/templates/default/Gemfile.erb
 - lib/robopigeon/extend/templates/default/README.erb.md
-- lib/robopigeon/extend/templates/default/lib/robopigeon-extension.erb.rb
-- lib/robopigeon/extend/templates/default/lib/robopigeon-extension/dsl.erb.rb
-- lib/robopigeon/extend/templates/default/lib/robopigeon-extension/helper_dsl.erb.rb
-- lib/robopigeon/extend/templates/default/lib/robopigeon-extension/version.erb.rb
-- lib/robopigeon/extend/templates/default/robopigeon-extension.erb.gemspec
+- lib/robopigeon/extend/templates/default/lib/robopigeon_extension.erb.rb
+- lib/robopigeon/extend/templates/default/lib/robopigeon_extension/dsl.erb.rb
+- lib/robopigeon/extend/templates/default/lib/robopigeon_extension/helper_dsl.erb.rb
+- lib/robopigeon/extend/templates/default/lib/robopigeon_extension/version.erb.rb
+- lib/robopigeon/extend/templates/default/robopigeon_extension.erb.gemspec
 - lib/robopigeon/extend/templates/default/spec/robopigeon-extension/dsl_spec.erb.rb
 - lib/robopigeon/extend/templates/default/spec/robopigeon-extension/helper_dsl_spec.erb.rb
 - lib/robopigeon/extend/templates/default/spec/spec_helper.erb.rb
@@ -310,6 +310,7 @@ files:
 - robopigeon
 - robopigeon.gemspec
 - robopigeon.rb
+- spec/initial_robopigeon_spec.rb
 homepage: https://gitlab.com/pigeons/robopigeon
 licenses:
 - MIT