concourse 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dbaa8912766aa4a943e923a480f29d28e48c6a1cd685441a8a9032c674416e5
-  data.tar.gz: 609eda21fa25d678fc45bcb271ac9899040caaa074dbd748a9f68f1b8b84b5bd
+  metadata.gz: b0107e8ffc49ba8bd8ad43183da66ecb29d89478440fd0cb70b9eb2e1305c427
+  data.tar.gz: 40fa32805af4c9d08d2b2b4f0ebcde942bd6e1135a98b491bba6f148cea1c1ee
 SHA512:
-  metadata.gz: 7c1cb37c152205f1b1d4e7ff0d84908323156564bc0bdb20f47d6cd346e02ad1f60dfd3b3182f153a8b6f560fd73a8f64d5dcba856becc9ee8a909f1d052116c
-  data.tar.gz: c4c72d86aad43c6ff3ef0557820d8f8481c27a7e856fe71eb5557aa24220b9fbc30edc8317193d9c59024793371008800185ba1d7c3a971a429820cf0131fa20
+  metadata.gz: 5e9e9633794c23f7306688fd979167def21e3f2efd5ab4ad3de73ba18f64ee87c3fe45accf0d19c4d3afb7cac8a54e198304e2b023b39bc3db40f1d65ffe26b9
+  data.tar.gz: af0504712cfbef8764296617f523eea2d1f97171857c58ea4b85d8e3da70a2e855f3baed3cffebff6af9f7e379711cba2d69d6c9fe2c63d7b68a2b31acddba81

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # concourse-gem changelog
 
+## 0.22.0 / 2019-01-18
+
+### Breaking changes
+
+* The name of the generated, final pipeline file is now `<pipeline_erb_filename>.generated`.
+
+
+### Features
+
+* Introduce rake task `concourse:prune-stalled-workers`
+* `Concourse.new` now takes an optional `:fly_target` named param to avoid passing this to each task. [#2] (Thanks, @ebmeierj!)
+* `Concourse.new` now takes an optional `:pipeline_erb_filename` named param to set the name of the pipeline file used. [#1] (Thanks, @ebmeierj!)
+* `Concourse.new` now takes an optional `:secrets_filename` named param to set the name of the private variable file used. [#1] (Thanks, @ebmeierj!)
+
+
 ## 0.21.0 / 2018-12-26
 
 * Introduce ruby 2.6 final (and remove 2.6-rc)

data/README.md

@@ -12,7 +12,7 @@ In your Rakefile,
 ``` ruby
 require 'concourse'
 
-Concourse.new("myproject").create_tasks!
+Concourse.new("myproject", fly_target: "myci").create_tasks!
 ```
 
 This will create a set of rake tasks for you.
@@ -21,21 +21,54 @@ This will create a set of rake tasks for you.
 rake concourse:init
 ```
 
-The `concourse:init` task will create a subdirectory named `concourse`, and create a Concourse pipeline file named `myproject.yml`, which will be interpreted as an ERB template. It will also ensure that files with sensitive data (`concourse/private.yml` and `concourse/myproject.final.yml`) are in `.gitignore`.
+The `concourse:init` task will create a subdirectory named `concourse`, and create a Concourse pipeline file named `<myproject>.yml`, which will be interpreted as an ERB template. It will also ensure that files with sensitive data (`concourse/private.yml` and `concourse/myproject.yml.generated`) are in `.gitignore`.
 
 
 ### Concourse subdirectory name
 
-You can choose a directory name other than `concourse`:
+You can choose a directory name other than the default `concourse`:
 
 ``` ruby
 Concourse.new("myproject", directory: "ci").create_tasks!
 ```
 
 
+### Concourse `fly` target name
+
+If the initializer is given no additional parameters, your fly target is assumed to be named "default":
+
+``` ruby
+Concourse.new("myproject").create_tasks! # `fly -t default <command>`
+```
+
+But this is likely an inappropriate default, and so you can specify your target name:
+
+``` ruby
+Concourse.new("myproject", fly_target: "myci").create_tasks! # `fly -t myci <command>`
+```
+
+
+### Pipeline file
+
+By default the pipeline file will be named `<myproject>.yml`, but can be set to something else:
+
+``` ruby
+Concourse.new("myproject", pipeline_erb_filename: "pipeline.yml").create_tasks!
+```
+
+Note that the generated, final pipeline file is always named `<pipeline_erb_filename>.generated`.
+
+
+
 ### Keeping credentials private
 
-If the file `concourse/private.yml` exists, it will be passed to the `fly` commandline with the `-l` option to fill in template values.
+You can use a separate file to keep your pipeline variables secure. By default, `concourse/private.yml` will be used. You can specify a different filename:
+
+``` ruby
+Concourse.new("myproject", secrets_filename: "secrets.yml").create_tasks!
+```
+
+If the secrets file exists, it will be passed to the `fly` commandline with the `-l` option to fill in template values.
 
 For example, I might have a concourse config that looks like this:
 
@@ -90,54 +123,50 @@ jobs:
 Note that the `windows` rubies are not Docker images, since Concourse's Houdini backend doesn't use Docker. Instead, these are implicitly referring to the supported ruby versions installed by the BOSH release at https://github.com/flavorjones/windows-ruby-dev-tools-release
 
 
-### `fly_target`
-
-Any rake task that needs to interact with your Concourse ATC requires a `fly_target` argument. The value should be a fly target `name`, and it's assumed that you're already logged in to that target.
-
-
 ### Managing your Concourse pipeline
 
 Tasks to manage a local pipeline file, generated from an ERB template:
 
 ```
-rake concourse:clean                # remove generate pipeline file
-rake concourse:generate             # generate and validate the pipeline file for myproject
+rake concourse:clean    # remove generate pipeline file
+rake concourse:generate # generate and validate the pipeline file for myproject
 ```
 
 A task to update your pipeline configuration:
 
 ```
-rake concourse:set[fly_target]      # upload the pipeline file for myproject
+rake concourse:set      # upload the pipeline file for myproject
 ```
 
 Tasks to publicly expose or hide your pipeline:
 
 ```
-rake concourse:expose[fly_target]   # expose the myproject pipeline
-rake concourse:hide[fly_target]     # hide the myproject pipeline
+rake concourse:expose   # expose the myproject pipeline
+rake concourse:hide     # hide the myproject pipeline
 ```
 
 Tasks to pause and unpause your pipeline:
 
 ```
-rake concourse:pause[fly_target]    # pause the myproject pipeline
-rake concourse:unpause[fly_target]  # unpause the myproject pipeline
+rake concourse:pause    # pause the myproject pipeline
+rake concourse:unpause  # unpause the myproject pipeline
 ```
 
 And, should you ever need to [nuke the site from orbit][ripley], a task to destroy your pipeline:
 
 ```
-rake concourse:destroy[fly_target]  # destroy the myproject pipeline
+rake concourse:destroy  # destroy the myproject pipeline
 ```
 
 
   [ripley]: https://www.youtube.com/watch?v=aCbfMkh940Q
 
+
 ### Running tasks with `fly execute`
 
 ```
-rake concourse:tasks                                       # list all the available tasks from the nokogiri pipeline
-rake concourse:task[fly_target,job_task,fly_execute_args]  # fly execute the specified task
+rake concourse:tasks                            # list all the available tasks from the nokogiri pipeline
+rake concourse:task[job_task,fly_execute_args]  # fly execute the specified task
 ```
 
 where:
@@ -149,22 +178,18 @@ where:
 ### Aborting running builds
 
 ```
-rake concourse:abort-builds[fly_target]  # abort all running builds for this pipeline
+rake concourse:abort-builds  # abort all running builds for this pipeline
 ```
 
 
-### Generating a sweet set of markdown badges
+### Pruning stalled concourse workers
 
-Would you like a markdown table of your jobs' passing/failing badges? Of course you would.
+Especially useful if you're deploying via BOSH, which often results in stalled workers;
 
 ```
-rake concourse:badges[fly_target,team_name]   # display a list of jobs and badge urls
+rake concourse:prune-stalled-workers  # prune any stalled workers
 ```
 
-where:
-
-* _optional_: `team_name` is the name of the pipeline's Concourse Team. Defaults to `main`.
-
 
 ## Installation
 

data/concourse.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "term-ansicolor"
+
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/concourse.rb

@@ -1,9 +1,14 @@
 require "concourse/version"
 require "yaml"
 require "tempfile"
+require 'term/ansicolor'
 
 class Concourse
   include Rake::DSL
+  include Term::ANSIColor
+
+  GITIGNORE_FILE           = ".gitignore"
+  GITATTRIBUTES_FILE       = ".gitattributes"
 
   # these numbers/names align with public docker image names
   RUBIES = {
@@ -15,14 +20,11 @@ class Concourse
 
   DEFAULT_DIRECTORY = "concourse"
 
-  attr_reader :project_name, :pipeline_filename, :pipeline_erb_filename, :directory, :private_var_file
-
-  def self.validate_fly_target task, task_args
-    unless task_args[:fly_target]
-      raise "ERROR: must specify a fly target, like `rake #{task.name}[targetname]`"
-    end
-    return task_args[:fly_target]
-  end
+  attr_reader :project_name
+  attr_reader :directory
+  attr_reader :pipeline_filename, :pipeline_erb_filename
+  attr_reader :fly_target
+  attr_reader :secrets_filename
 
   def self.url_for fly_target
     matching_line = `fly targets`.split("\n").grep(/^#{fly_target}/).first
@@ -46,12 +48,17 @@ class Concourse
     RUBIES[:mri].select { |r| r =~ /rc/ }
   end
 
-  def initialize project_name, args={}
+  def initialize project_name, options={}
     @project_name = project_name
-    @directory = args[:directory] || DEFAULT_DIRECTORY
-    @pipeline_filename = File.join(@directory, "#{project_name}.final.yml")
-    @pipeline_erb_filename = File.join(@directory, "#{project_name}.yml")
-    @private_var_file = File.join(@directory, "private.yml")
+
+    @directory = options[:directory] || DEFAULT_DIRECTORY
+    @fly_target = options[:fly_target] || "default"
+    base_pipeline_erb_filename = options[:pipeline_erb_filename] || "#{project_name}.yml"
+    base_secrets_filename = options[:secrets_filename] || "private.yml"
+
+    @pipeline_filename = File.join(@directory, "#{base_pipeline_erb_filename}.generated")
+    @pipeline_erb_filename = File.join(@directory, base_pipeline_erb_filename)
+    @secrets_filename = File.join(@directory, base_secrets_filename)
   end
 
   def erbify document_string, *args
@@ -61,10 +68,32 @@ class Concourse
   def rake_init
     FileUtils.mkdir_p File.join(directory, "tasks")
     FileUtils.touch pipeline_erb_filename
-    File.open ".gitignore", "a" do |f|
-      f.puts private_var_file
-      f.puts pipeline_filename
+    ensure_in_gitignore secrets_filename
+    ensure_in_gitignore pipeline_filename
+  end
+
+  def ensure_in_gitignore file_glob
+    if File.exist?(GITIGNORE_FILE)
+      if File.read(GITIGNORE_FILE).split("\n").include?(file_glob)
+        note "found '#{file_glob}' already present in #{GITIGNORE_FILE}"
+        return
+      end
     end
+    note "adding '#{file_glob}' to #{GITIGNORE_FILE}"
+    File.open(GITIGNORE_FILE, "a") { |f| f.puts file_glob }
+  end
+
+  def sh command
+    running "(in #{Dir.pwd}) #{command}"
+    super command, verbose: false
+  end
+
+  def running message
+    print bold, red, "RUNNING: ", reset, message, "\n"
+  end
+
+  def note message
+    print bold, green, "NOTE: ", reset, message, "\n"
   end
 
   def create_tasks!
@@ -99,23 +128,21 @@ class Concourse
       end
 
       desc "upload the pipeline file for #{project_name}"
-      task "set", [:fly_target] => ["generate"] do |t, args|
-        fly_target = Concourse.validate_fly_target t, args
+      task "set" => ["generate"] do |t, args|
         options = [
           "-p '#{project_name}'",
           "-c '#{pipeline_filename}'",
         ]
-        if File.exist? private_var_file
-          puts "using #{private_var_file} to resolve template vars"
-          options << "-l '#{private_var_file}'"
+        if File.exist? secrets_filename
+          note "using #{secrets_filename} to resolve template vars"
+          options << "-l '#{secrets_filename}'"
         end
         sh "fly -t #{fly_target} set-pipeline #{options.join(" ")}"
       end
 
       %w[expose hide pause unpause destroy].each do |command|
         desc "#{command} the #{project_name} pipeline"
-        task "#{command}", [:fly_target] do |t, args|
-          fly_target = Concourse.validate_fly_target t, args
+        task command do |t, args|
           sh "fly -t #{fly_target} #{command}-pipeline -p #{project_name}"
         end
       end
@@ -136,14 +163,12 @@ class Concourse
           tasks << "#{job["name"]}/#{task["task"]}"
         end
 
-        puts "Available Concourse tasks for #{project_name} are:"
+        note "Available Concourse tasks for #{project_name} are:"
         tasks.sort.each { |task| puts " * #{task}" }
       end
 
       desc "fly execute the specified task"
-      task "task", [:fly_target, :job_task, :fly_execute_args] => "generate" do |t, args|
-        fly_target = Concourse.validate_fly_target t, args
-
+      task "task", [:job_task, :fly_execute_args] => "generate" do |t, args|
         job_task = args[:job_task]
         unless job_task
           raise "ERROR: must specify a task name, like `rake #{t.name}[target,taskname]`"
@@ -168,16 +193,25 @@ class Concourse
       #  builds commands
       #
       desc "abort all running builds for this pipeline"
-      task "abort-builds", [:fly_target] do |t, args|
-        fly_target = Concourse.validate_fly_target t, args
-
-        `fly -t #{fly_target} builds`.split("\n").each do |line|
+      task "abort-builds" do |t, args|
+        `fly -t #{fly_target} builds`.each_line do |line|
           pipeline_job, build_id, status = *line.split(/\s+/)[1,3]
           next unless status == "started"
 
           sh "fly -t #{fly_target} abort-build -j #{pipeline_job} -b #{build_id}"
         end
       end
+
+      #
+      #  worker commands
+      #
+      desc "prune any stalled workers"
+      task "prune-stalled-workers" do |t, args|
+        `fly -t #{fly_target} workers | fgrep stalled`.each_line do |line|
+          worker_id = line.split.first
+          system("fly -t #{fly_target} prune-worker -w #{worker_id}")
+        end
+      end
     end
   end
 

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.21.0"
+  VERSION = "0.22.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Rake tasks for Concourse pipelines.