robopigeon 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe9a65f475eff9c6c1204035fd2fa3acd934346e59b0562890fa787d70dd63eb
-  data.tar.gz: 62e54d559418f871ffb4e84a6bca22699f036653c75bf0433158fcdeef017d1e
+  metadata.gz: f5f0eb12780af404e3c5d222d9468804f0b7aec1aeef45407980ee90b578d66f
+  data.tar.gz: c9947148df1def3093400399632b4fb7225be2c679fd141841ceae2a4b49e908
 SHA512:
-  metadata.gz: 19eb5edf119c685f46e81fda2829aae511627d69565a4452f5cad707b955521cf64ff6dd07aa450d7d164605813bd30819ef8547b108c10bd1d636df7a8a7ebc
-  data.tar.gz: 51583e67e7f97a049bc6f92649f34c91caa1aff8ccab8ed4a82b90dea97312e589d04291e881852ec030ebb20b9abd2d5d85a7b3c199c61c4a1de4eb2e24bf22
+  metadata.gz: f8d9516e989b6cbae9a5bd5c6fe41224569be78689288ce35e322cdb15dc35549a706bd37b29e0b3c11440ce7ca4b92a73130a27edb81e9b3579d44ca7661b49
+  data.tar.gz: 86704bdca6792091a21231d53ee8aa8c3d5175c77a118b796baf84d05a1aa91c7907b09998b8fe02233863d908654d8e598bd243fd18df897ca7f88b2ec5241a

data/.gitignore

@@ -14,3 +14,4 @@
 Gemfile.lock
 .env
 robopigeon-0.1.0.gem
+coverage

data/.rubocop.yml

@@ -1,8 +1,6 @@
 AllCops:
   Exclude:
-    - 'db/**/*'
-    - 'Vagrantfile'
-    - 'vendor/**/*'
+    - 'lib/robopigeon/extend/templates/**/*'
 Style/SingleLineBlockParams:
   Enabled: false
 Style/MultilineBlockChain:

data/.version

@@ -1 +1 @@
-0.1.0
+0.2.0

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 0.2.0 (2019-03-29)
+
+### Added (3 changes)
+
+- Automatically generate extensions with `robopigoeon new [extension name]`
+- DSL for making commits in gitlab projects via api
+- DSL to trigger and watch jenkins jobs
+
+## 0.1.0 (2019-03-12)
+
+### Added
+
+- DSL for creating and merging merge requests in gitlab
+- DSL for creating jira tickets and waiting for them to transition
+- DSL for sending slack messages to a person or channel
+- Helper DSL for looking up slack user names
+- Helper DSL for looking up last deployment information
+- Helper DSL for reading and parsing markdown ERB files

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2019 Alex Ives
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -34,129 +34,9 @@ Best way to get started is by running `robopigeon init` and having it write the
 
 Then, you can reference the DSL below to make changes to your file.
 
-## DSL Reference:
-- [Helpers](#helpers)
-- [Slack](#slack-1)
-- [GitLab](#gitlab-1)
+## DSL Reference
 
-### Helpers
-
-Helpers can be used anywhere in your config! They're useful for things like looking up someone's slack username to mention it in an email, or looking up who's oncall via pagerduty!
-
-#### Slack
-```ruby
-slack_name_for 'Email or Name'         # slack username just with the @ sign
-slack_user_for 'Email or Name'         # slack message formatted slack user
-slack_user_group 'Group id'            # slack message group mention with an id
-```
-
-#### Git
-```ruby
-git_committer_name                     # name of the person who made the last commit
-git_committer_email                    # email address of the person who made the last commit
-git_merger_name                        # name of the person who made the last merge
-git_merger_email                       # email address of the person who made the last merge
-git_branch_merged_source               # source branch of the last merge
-git_branch_merged_target               # target branch of the last merge
-```
-
-#### GitLab
-```ruby
-deployment_sha 'environment name'      # the current deployed sha for a given environment
-deployment_ref 'environment name'      # the current deploy ref for a given environment
-deployment_shortlog 'environment name' # the shortlog comparison between head and an environment
-```
-
-### Slack
-
-Here's an example of how to use the slack integration!
-
-There are two basic parts of the slack integration, there's the top level with the api_key, bot name, and emoji icon. And the job configuration that let's you select channels, users, and specify the text and attachments.
-
-```ruby
-slack do
-  api_key ENV['SLACK_API_KEY'] # Sets the api key, I like to set it as an env var, defaults to ENV['SLACK_API_KEY']
-  name 'RoboPigeon 9000' # The name that Slack displays in the chat
-  emoji ':robot:' # The emoji icon that the bot uses
-end
-
-job 'super basic' do
-  slack do
-    channel '#testing-slackbots'
-    text 'some information you want to relate'
-  end
-end
-
-job 'mention a user' do
-  slack do
-    channel '#testing-slackbots'
-    text "#{slack_user_for ENV['GITLAB_USER_EMAIL']} did something awesome!"
-  end
-end
-
-job 'test failed' do
-  slack do
-    channel '#testing-slackbots' # A channel to post the message to
-    channel '#testing-more-slackbots' # Another channel to post the message to
-    user 'someone@example.com' # A user that it also sends the message to
-    user 'someone-else@example.com' # Another user that it also sends the message to
-    text "Test on #{ENV['CI_MERGE_REQUEST_SOURCE_BRANCH_NAME']} has failed!"
-    attachment do
-      title 'Website'
-      title_link 'http://alex.ives.mn'
-      pretext 'Here is a button!'
-      color 'danger'
-      # Actions take type, text, url, and style
-      action 'button', 'Website', 'https://alex.ives.mn', 'danger'
-    end
-  end
-end
-
-job 'in a different workspace' do
-  slack do
-    api_key ENV['SLACK_KEY_FOR_SECOND_SPACE']
-    name 'SadBot 9000'
-    emoji ':sad-pigeon:'
-    channel '#testing-slackbots'
-    user 'someone@example.com'
-    text 'Sent to a different workspace'
-  end
-end
-
-job 'with complex attachments' do
-  slack do
-    user ENV['GITLAB_USER_EMAIL']
-    attachment do
-      color 'good'
-      fallback "Stuff is happening! <#{ENV['CI_PIPELINE_URL']}|Pipeline> <#{ENV['CI_PROJECT_URL']}|Project>"
-      action 'button', 'Pipeline', ENV['CI_PIPELINE_URL'], 'primary'
-      action 'button', 'Project', ENV['CI_PROJECT_URL'], 'primary'
-    end
-    attachment do
-      color 'danger'
-      fallback "Stuff is happening! <#{ENV['CI_PIPELINE_URL']}|Pipeline> <#{ENV['CI_PROJECT_URL']}|Project>"
-      action 'button', 'Bad Pipeline', ENV['CI_PIPELINE_URL'], 'danger'
-      action 'button', 'Bad Project', ENV['CI_PROJECT_URL']
-    end
-  end
-end
-```
-
-### GitLab
-
-```ruby
-gitlab do
-  api_url 'https://gitlab.example.com/api/v4' # api endpoint for your gitlab server, defaults to ENV['CI_API_V4_URL']
-  api_key ENV['GITLAB_API_KEY']               # api key for your gitlab server, defaults to ENV['GITLAB_API_KEY']
-end
-
-job 'comment on a merge request' do
-  gitlab do
-    branch ENV['CI_COMMIT_REF_NAME']
-    merge_request_comment 'This comment will appear on all merge requests for the current specified branch'
-  end
-end
-```
+Coming soon, stay tuned. In the mean time you can [look at our example file](https://gitlab.com/pigeons/robopigeon/blob/master/lib/robopigeon/resources/initial_robopigeon.rb).
 
 ## Development
 
@@ -166,7 +46,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/robopigeon/robopigeon.
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/pigeons/robopigeon.
 
 ### Contributors
 
@@ -187,9 +67,9 @@ GitLab
 - [x] Get data from the gitlab deployments api as a helper
 - [x] Add helpers to get a list of jira tickets since the provided deployment
 - [x] Create Tag
-- [ ] Create Commits
+- [x] Create Commits
 
-Semver Helpers
+Semver
 - [ ] Read a version from a file
 - [ ] Update version files
 
@@ -209,10 +89,22 @@ Git
 - [x] Add helpers to get information about changes since the last release
 
 Jenkins
-- [ ] Kick off and monitor a jenkins job until it is completed
+- [x] Kick off and monitor a jenkins job until it is completed
 
 Extensions
-- [ ] Create basic example dsl extension gem template
+- [x] Create basic example dsl extension gem template
+
+PagerDuty
+- [ ] Get current oncall user from pagerduty api
+
+Risk Metrics Helpers
+- [ ] Globally configure deploy risk metrics
+- [ ] Output risk metrics as markdown via kramdown
+
+Changelog
+- [ ] Aggregates changes into log
+- [ ] Helpers provide changes since last deployment
+- [ ] Changelog yaml front matter informs risk of change
 
 ### Features for future version
 
@@ -226,6 +118,8 @@ GitLab
 - [ ] Create Issue
 - [ ] Update issue tags
 - [ ] Assign Issue
+- [ ] Write file to wiki page
+- [ ] Write to snippet
 
 GitHub
 - [ ] Create, comment on, and merge pull requests
@@ -236,18 +130,27 @@ GitHub
 - [ ] Create Issue
 - [ ] Update issue tags
 - [ ] Assign Issue
+- [ ] Write to Gist
+
+Gitter
+- [ ] Post notifications to channels or users
+- [ ] Post notifications and wait for a response
+
+Confluence
+- [ ] Write Content to Confluence Page
+
+MediaWiki
+- [ ] Write Content to Wiki Page
 
 Slack
 - [ ] Migrate to block syntax for messages
 
-Changelog
-- [ ] Aggregates changes into log
-- [ ] Helpers provide changes since last deployment
-
 Extensions
 - [ ] Default jobs extension
 - [ ] Jira ticket configuration extension
 - [ ] Slack action template
+- [ ] Gitlab issue configuration extension
+- [ ] GitHub issue configuration extension
 
 ### Technical Debt
 

data/lib/robopigeon/dsl/base.rb

@@ -0,0 +1,8 @@
+module RoboPigeon::Dsl
+  # this inherits from job, so that the job dsls are available in
+  # extensions. That's very helpful if you're trying to write an
+  # extension that interfaces with another extension or built in.
+  class Base < RoboPigeon::Dsl::Job
+    include RoboPigeon::Dsl::Helpers
+  end
+end

data/lib/robopigeon/dsl/initial_jobs.rb

@@ -23,6 +23,15 @@ module RoboPigeon::Dsl::InitialJobs
     }
   end
 
+  def init_new
+    jobs['new'] = {
+      desc: 'Create a new extension for RoboPigeon',
+      action: proc do
+        RoboPigeon::Extensions::Cli.invoke(ARGV)
+      end
+    }
+  end
+
   def init_help
     this_job = {
       desc: 'Show usage information',

data/lib/robopigeon/dsl/job.rb

@@ -12,11 +12,21 @@ RoboPigeon::Documentarian.add_block(
 module RoboPigeon::Dsl
   class Job
     include RoboPigeon::Dsl::Helpers
+
+    def self.run(&block)
+      instance = new
+      instance.instance_eval(&block)
+    end
   end
 end
 
 module RoboPigeon::Dsl
   class Root
+    def self.run(&block)
+      instance = new
+      instance.instance_eval(&block)
+    end
+
     def job(*args, &block)
       this_job = {
         desc: args.pop,

data/lib/robopigeon/dsl.rb

@@ -1,6 +1,7 @@
 require 'robopigeon/dsl/helpers'
-require 'robopigeon/dsl/initial_jobs'
 require 'robopigeon/dsl/job'
+require 'robopigeon/dsl/base'
+require 'robopigeon/dsl/initial_jobs'
 
 module RoboPigeon::Dsl
   class Root
@@ -12,6 +13,7 @@ module RoboPigeon::Dsl
       self.jobs = {}
       base
       init_help
+      init_new
       if File.exist?(file)
         instance_exec do
           eval(File.read(file))
@@ -30,16 +32,16 @@ module RoboPigeon::Dsl
     end
 
     def usage
-      max_size = jobs.keys.max_by(&:length).size
+      max_size = jobs.keys.reject(&:nil?).max_by(&:length).size
       jobs_strings = jobs.keys.reject do |key|
-        jobs[key][:hidden]
+        key.nil? || jobs[key][:hidden]
       end.map do |name|
         padding = ' ' * (max_size - name.length)
         "  '#{name}' #{padding}- #{jobs[name][:desc]}"
       end.join("\n")
       puts "Usage: robopigeon 'job name'"
       puts "Jobs are configured in #{file}"
-      puts 'See https://gitlab.com/robopigeon/robopigeon for configuration'
+      puts 'See https://gitlab.com/pigeons/robopigeon for configuration'
       puts "Configured Jobs:\n#{jobs_strings}"
     end
   end

data/lib/robopigeon/extend/cli.rb

@@ -0,0 +1,34 @@
+require 'optparse'
+
+module RoboPigeon::Extensions
+  class Cli
+    class << self
+      def invoke(args)
+        template = 'default'
+        path = FileUtils.pwd
+        optparse = OptionParser.new do |opts|
+          opts.banner = 'Usage: robopigeon new [options] name'
+
+          opts.on('-d', '--default', 'use the default template') do
+            template = 'default'
+          end
+
+          opts.on('-h', '--help', 'Show help message') do
+            puts opts
+            exit 1
+          end
+
+          opts.on('-p', '--path [path]', 'path to where the gem should be created') do |selected_path|
+            path = selected_path
+          end
+        end
+
+        args.shift
+        options = optparse.parse(args)
+        name = options.shift
+
+        RoboPigeon::Extensions::Template.render(name, path, template)
+      end
+    end
+  end
+end

data/lib/robopigeon/extend/template.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require 'erb'
+
+module RoboPigeon::Extensions
+  class Template
+    TEMPLATE_PATH = File.expand_path('../templates/', __FILE__).freeze
+    attr_accessor :name, :template
+
+    def self.render(name, path, template='default')
+      to_render = new
+      to_render.name = name
+      to_render.template = template
+      raise "No template with name #{template}" unless File.directory?("#{TEMPLATE_PATH}/#{template}")
+
+      to_render.render_to(path)
+    end
+
+    def render_to(path)
+      cwd = FileUtils.pwd
+      base = File.expand_path("#{path}/robopigeon-#{name}")
+      FileUtils.cd "#{TEMPLATE_PATH}/#{template}"
+      FileUtils.mkdir_p base.to_s
+      Dir.glob('{**{,/*/**},.*}') do |file|
+        new_filename = file.gsub('extension', name).gsub('.erb', '')
+        if File.directory?(file)
+          FileUtils.mkdir("#{base}/#{new_filename}") unless File.exist? "#{base}/#{new_filename}"
+          puts "Created directory #{base}/#{new_filename}"
+        else
+          content = ERB.new(File.read(file)).result(binding)
+          File.write("#{base}/#{new_filename}", content)
+          puts "Created #{base}/#{new_filename}"
+        end
+      end
+      FileUtils.cd cwd
+    end
+
+    def extension_name_lower
+      name.downcase
+    end
+
+    def extension_name_upper
+      name.capitalize
+    end
+
+    def user_email
+      `git config user.email`.strip
+    end
+
+    def user_name
+      `git config user.name`.strip
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore this so that we get up to date stuff.
+Gemfile.lock
+.env
+robopigeon-0.1.0.gem

data/lib/robopigeon/extend/templates/default/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+.rspec: &rspec
+  stage: test
+  script:
+    - bundle install
+    - bundle exec rspec
+
+stages:
+  - test
+
+Rspec:2.5:
+  <<: *rspec
+  image: ruby:2.5
+
+Rspec:2.3:
+  <<: *rspec
+  image: ruby:2.3
+
+Rspec:2.1:
+  <<: *rspec
+  image: ruby:2.1
+
+Rubocop:
+  image: ruby:2.5
+  stage: test
+  script:
+    - bundle install
+    - bundle exec rubocop

data/lib/robopigeon/extend/templates/default/.rubocop.yml

@@ -0,0 +1,50 @@
+Style/SingleLineBlockParams:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Documentation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Style/CommentAnnotation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/Next:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false

data/lib/robopigeon/extend/templates/default/.version

@@ -0,0 +1 @@
+0.0.1

data/lib/robopigeon/extend/templates/default/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in robopigeon.gemspec
+gemspec
+
+gem 'robopigeon', path: '../robopigeon'

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

@@ -0,0 +1,35 @@
+# RoboPigeon-<%= extension_name_upper %>
+
+TODO: Add a description of what dsls/helpers this adds.
+
+## Installation
+
+This Gem is developed against ruby 2.5, but is tested in CI against the latest versions of `2.1`, `2.3`, and `2.5`
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'robopigeon-<%= extension_name_lower %>'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install robopigeon-<%= extension_name_lower %>
+
+## Usage
+
+TODO: Add usage instructions for your new DSLs
+
+## Development
+
+After checking out the repo, run `bundle install`
+
+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 %>.

data/lib/robopigeon/extend/templates/default/lib/robopigeon-extension/dsl.erb.rb

@@ -0,0 +1,39 @@
+module RoboPigeon::Dsl
+  class <%= extension_name_upper %>Root < RoboPigeon::Dsl::Base
+    # This is where you include your top level dsls used for configuring
+    # global settings like api keys or api urls. In general, it is useful
+    # to also include them in the individual job settings in case a job
+    # needs to override them.
+    # For example, you might set your api key for a service to talk to:
+    # def api_key(key)
+    #   <%= extension_name_upper %>::Client.api_key = key
+    # end
+    def do_some_global_thing
+      'some global thing'
+    end
+  end
+
+  class <%= extension_name_upper %> < <%= extension_name_upper %>Root
+    # This is where you include job specific dsls! This is used for actions
+    # that only take place when running a job, this could be something like
+    # pre-configured slack notifications or more complex things.
+    # For example, if you wanted a dsl that always sends a slack message to
+    # a certain channel:
+    # def request_approval(description, ticket_number)
+    #   slack do
+    #     channel '#approval-requests'
+    #     message "#{slack_approvers_mention}: #{slack_user_for ENV['GITLAB_USER_EMAIL'] would like approval for #{jira_slack_link} - #{description}"
+    #   end
+    # end
+
+    # Alternately, you can add whole new services, like say you wanted an
+    # alert in your alerting software, you could write code to trigger it
+    # in here!
+    # def trigger_alert(description, team)
+    #   # Code goes here to trigger the alert
+    # end
+    def do_something
+      'nothing happens yet...'
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/lib/robopigeon-extension/helper_dsl.erb.rb

@@ -0,0 +1,18 @@
+module RoboPigeon::Dsl::Helpers
+  module <%= extension_name_upper %>
+    # This file contains methods that are added to all levels of the DSL, you can
+    # add new ones of your own in here! For example, if you wanted something that
+    # holds a specific slack subteam name, you could do something like:
+    # def slack_approvers_mention
+    #   "<!subteam^A1342B>"
+    # end
+    # Then you could reference it in a slack notification:
+    # slack do
+    #   channel "#request-approval"
+    #   message "#{slack_approvers_mention} - I would like approval for my life!"
+    # end
+    def some_helper_dsl
+      'nothing happens here yet'
+    end
+  end
+end

data/lib/robopigeon/extend/templates/default/lib/robopigeon-extension/version.erb.rb

@@ -0,0 +1,5 @@
+module RoboPigeon
+  module <%= extension_name_upper %>
+    VERSION = File.read(File.join(__dir__, '../../.version')).freeze
+  end
+end