concourse 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0107e8ffc49ba8bd8ad43183da66ecb29d89478440fd0cb70b9eb2e1305c427
-  data.tar.gz: 40fa32805af4c9d08d2b2b4f0ebcde942bd6e1135a98b491bba6f148cea1c1ee
+  metadata.gz: 50517da26e0d7eb88bb231814b9a664ee17bc5e08c278eb2724e472797832867
+  data.tar.gz: 7c0ce4a2fc2844bf187ba242d47c62c5b1ab684ef85d6194520c90807b10b8c3
 SHA512:
-  metadata.gz: 5e9e9633794c23f7306688fd979167def21e3f2efd5ab4ad3de73ba18f64ee87c3fe45accf0d19c4d3afb7cac8a54e198304e2b023b39bc3db40f1d65ffe26b9
-  data.tar.gz: af0504712cfbef8764296617f523eea2d1f97171857c58ea4b85d8e3da70a2e855f3baed3cffebff6af9f7e379711cba2d69d6c9fe2c63d7b68a2b31acddba81
+  metadata.gz: c19043e491bd57cfc3f57babcc494ac0eee2e35e501f3a45e076af6655c8b94940f89ece2d7b067f762039a0723031e3329c2b635525927bf0a40202158727be
+  data.tar.gz: fb3024061b013b796d65e68757cb9aade22126868d7c3c29be367c0ac39142da96c3024575c7753f5c3909f67d53104cb25c5eb1fd85a8a283c99b8ddc41c7f2

data/.gitignore

@@ -10,3 +10,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+# npm
+node_modules
+package-lock.json

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # concourse-gem changelog
 
+## 0.23.0 / 2019-01-19
+
+### Features
+
+* Support for multiple pipelines.
+
+
 ## 0.22.0 / 2019-01-18
 
 ### Breaking changes

data/README.md

@@ -1,72 +1,120 @@
-# Concourse
+# concourse (the rubygem)
 
-The `Concourse` gem provides rake tasks to help you manage your Concourse pipelines, and to assist in running individual tasks with `fly execute`.
+The `concourse` gem provides rake tasks to help you manage Concourse pipelines, jobs, and workers, and to assist in running tasks with `fly execute`.
 
 If you're not familiar with Concourse CI, you can read up on it at https://concourse.ci
 
 
-## Usage
+## Contents
 
-In your Rakefile,
+<!-- to update this TOC run `rake readme_toc` -->
 
-``` ruby
-require 'concourse'
+<!-- toc -->
 
-Concourse.new("myproject", fly_target: "myci").create_tasks!
-```
+- [Basic Usage](#basic-usage)
+  * [Install](#install)
+  * [Add to your `Rakefile`](#add-to-your-rakefile)
+  * [Set up your Concourse pipeline](#set-up-your-concourse-pipeline)
+- [Concourse pipeline configuration](#concourse-pipeline-configuration)
+  * [ERB Templating and `RUBIES`](#erb-templating-and-rubies)
+  * [Secrets](#secrets)
+  * [Multiple pipelines](#multiple-pipelines)
+- [Configuration](#configuration)
+  * [`directory`: Concourse subdirectory name](#directory-concourse-subdirectory-name)
+  * [`fly_target`: Concourse `fly` target name](#fly_target-concourse-fly-target-name)
+  * [`pipeline_erb_filename`: Pipeline filename](#pipeline_erb_filename-pipeline-filename)
+  * [`secrets_filename`: Secrets filename](#secrets_filename-secrets-filename)
+- [Rake Tasks](#rake-tasks)
+  * [Manage your Concourse pipeline](#manage-your-concourse-pipeline)
+  * [List pipeline tasks](#list-pipeline-tasks)
+  * [Run a Concourse task with `fly execute`](#run-a-concourse-task-with-fly-execute)
+  * [Abort running builds](#abort-running-builds)
+  * [Prune stalled concourse workers](#prune-stalled-concourse-workers)
+- [Contributing](#contributing)
+- [License](#license)
 
-This will create a set of rake tasks for you.
+<!-- tocstop -->
 
-``` sh
-rake concourse:init
-```
+## Basic Usage
 
-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`.
+### Install
 
+Add this line to your application's Gemfile:
 
-### Concourse subdirectory name
+```ruby
+gem 'concourse'
+```
 
-You can choose a directory name other than the default `concourse`:
+and then run `bundle`.
 
-``` ruby
-Concourse.new("myproject", directory: "ci").create_tasks!
-```
+You can also install it via `gem install concourse`.
 
 
-### Concourse `fly` target name
+### Add to your `Rakefile`
 
-If the initializer is given no additional parameters, your fly target is assumed to be named "default":
+The primary functionality of the Concourse gem is to provide rake tasks. So, in your Rakefile:
 
 ``` ruby
-Concourse.new("myproject").create_tasks! # `fly -t default <command>`
+require 'concourse'
+
+Concourse.new("myproject").create_tasks!
 ```
 
-But this is likely an inappropriate default, and so you can specify your target name:
+### Set up your Concourse pipeline
 
-``` ruby
-Concourse.new("myproject", fly_target: "myci").create_tasks! # `fly -t myci <command>`
+``` sh
+rake concourse:init
 ```
 
+The `concourse:init` task will do a few different things for you:
 
-### Pipeline file
+1. create a subdirectory named `concourse` (or whatever you've configured with the `:directory` parameter)
+2. create an empty Concourse pipeline file in that subdirectory named `<myproject>.yml` (or whatever you've configured with the `:pipeline_erb_filename` parameter)
+3. ensure git will ignore your secrets file named `private.yml` (or whatever you've configured with the `:secrets_filename` parameter)
+4. ensure git will ignore the generated pipeline file (named after your ERB pipeline file as `<pipeline_erb_filename>.generated`)
 
-By default the pipeline file will be named `<myproject>.yml`, but can be set to something else:
+
+## Concourse pipeline configuration
+
+### ERB Templating and `RUBIES`
+
+Your Concourse pipeline configuration file, `<myproject>.yml` (or whatever you've configured with the `:pipeline_erb_filename` parameter), will be treated like an ERB template.
+
+(If you're unfamiliar with ERB and how you can mix Ruby into the document, you can [read about it here](https://www.stuartellis.name/articles/erb/).)
+
+The ruby variable `RUBIES` is defined in the ERB binding during pipeline file generation. This variable looks like:
 
 ``` ruby
-Concourse.new("myproject", pipeline_erb_filename: "pipeline.yml").create_tasks!
+  # these numbers/names align with public docker image names
+  RUBIES = {
+    mri:     %w[2.1 2.2 2.3 2.4], # docker repository: "ruby"
+    jruby:   %w[1.7 9.1],         # docker repository: "jruby"
+    rbx:     %w[latest],          # docker repository: "rubinius/docker"
+    windows: %w[2.3 2.4]          # windows-ruby-dev-tools-release
+  }
 ```
 
-Note that the generated, final pipeline file is always named `<pipeline_erb_filename>.generated`.
+and allows you to write a pipeline like this to get coverage on all the supported rubies:
 
+``` yaml
+# myproject.yml
+jobs:
+  <% for ruby_version in RUBIES[:mri] %>
+  - name: "ruby-<%= ruby_version %>"
+    plan:
+      - get: git-master
+        trigger: true
+      - task: rake-test
+    ...
+  <% end %>
+```
 
+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
 
-### Keeping credentials private
 
-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:
+### Secrets
 
-``` ruby
-Concourse.new("myproject", secrets_filename: "secrets.yml").create_tasks!
-```
+You can use a separate file to keep your pipeline variables secret. By default, `concourse/private.yml` will be used. This filename can also be configured (see below)
 
 If the secrets file exists, it will be passed to the `fly` commandline with the `-l` option to fill in template values.
 
@@ -91,128 +139,171 @@ github-repo-status-access-token: "your-token-here"
 and the final generate template will substitute your credentials into the appropriate place.
 
 
-### Templating and `RUBIES`
+### Multiple pipelines
 
-The ruby variable `RUBIES` is defined in the ERB binding during pipeline file generation. This variable looks like:
+Setting up multiple pipelines might be useful for you, for example one pipeline for running tests against `master` and another for pull requests; or a pipeline for tests and a pipeline for deployments.
+
+If you'd like to set up multiple pipelines, invoke Concourse in your Rakefile like this:
 
 ``` ruby
-  # these numbers/names align with public docker image names
-  RUBIES = {
-    mri:     %w[2.1 2.2 2.3 2.4], # docker repository: "ruby"
-    jruby:   %w[1.7 9.1],         # docker repository: "jruby"
-    rbx:     %w[latest],          # docker repository: "rubinius/docker"
-    windows: %w[2.3 2.4]          # windows-ruby-dev-tools-release
-  }
+require 'concourse'
+
+Concourse.new("myproject") do |c|
+  c.add_pipeline "master", "myproject.yml"
+  c.add_pipeline "pull-requests", "pr.yml"
+  c.add_pipeline "deploy", "big-red-button.yml"
+end
 ```
 
-and allows you to write a pipeline like this to get coverage on all the supported rubies:
+Note that when you use the block form:
 
-``` yaml
-# myproject.yml
-jobs:
-  <% for ruby_version in RUBIES[:mri] %>
-  - name: "ruby-<%= ruby_version %>"
-    plan:
-      - get: git-master
-        trigger: true
-      - task: rake-test
-    ...
-  <% end %>
+* it's not necessary to explicitly call `#create_tasks!`
+* only the pipelines declared via `#add_pipeline` will be managed
+
+
+## Configuration
+
+### `directory`: Concourse subdirectory name
+
+You can choose a directory name other than the default `concourse`:
+
+``` ruby
+Concourse.new("myproject", directory: "ci").create_tasks!
 ```
 
-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`: Concourse `fly` target name
+
+If the initializer is given no additional parameters, your fly target is assumed to be named "default". 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_erb_filename`: Pipeline filename
+
+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`.
+
 
 
-### Managing your Concourse pipeline
+### `secrets_filename`: Secrets filename
+
+You can use a separate file to keep your pipeline variables secret. By default, `concourse/private.yml` will be used. You can specify a different filename:
+
+``` ruby
+Concourse.new("myproject", secrets_filename: "secrets.yml").create_tasks!
+```
+
+
+## Rake Tasks
+
+
+### Manage 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 generated pipeline files
+rake concourse:generate  # generate and validate the pipeline files for myproject
 ```
 
 A task to update your pipeline configuration:
 
 ```
-rake concourse:set      # upload the pipeline file for myproject
+rake concourse:set       # upload the pipeline files for myproject
 ```
 
 Tasks to publicly expose or hide your pipeline:
 
 ```
-rake concourse:expose   # expose the myproject pipeline
-rake concourse:hide     # hide the myproject pipeline
+rake concourse:expose    # expose the myproject pipelines
+rake concourse:hide      # hide the myproject pipelines
 ```
 
 Tasks to pause and unpause your pipeline:
 
 ```
-rake concourse:pause    # pause the myproject pipeline
-rake concourse:unpause  # unpause the myproject pipeline
+rake concourse:pause     # pause the myproject pipelines
+rake concourse:unpause   # unpause the myproject pipelines
 ```
 
 And, should you ever need to [nuke the site from orbit][ripley], a task to destroy your pipeline:
 
 ```
-rake concourse:destroy  # destroy the myproject pipeline
+rake concourse:destroy   # destroy the myproject pipelines
 ```
 
-
   [ripley]: https://www.youtube.com/watch?v=aCbfMkh940Q
 
 
-### Running tasks with `fly execute`
+### List pipeline tasks
+
+You can see a list of all the tasks defined in your pipelines:
 
 ```
-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
+rake concourse:tasks  # list all the available tasks from the myproject pipelines
 ```
 
-where:
-
-* _required_: `job_task` is formatted as `job-name/task-name`, for example, `ruby-2.4/rake-test`. Run the `concourse:tasks` rake task to see all available names.
-* _optional_: `fly_execute_args` will default to map the project directory to a resource with the project name, e.g. `--input=myproject=.`, so your pipeline must name the input resource appropriately in order to use the default.
-
-
-### Aborting running builds
+You'll see output suitable for the `concourse:task` rake task, formatted as `job-name/task-name`, looking something like:
 
 ```
-rake concourse:abort-builds  # abort all running builds for this pipeline
+RUNNING: (in /home/flavorjones/code/oss/nokogiri) fly validate-pipeline -c concourse/nokogiri.yml.generated
+looks good
+NOTE: Available Concourse tasks for nokogiri are:
+ * jruby-9.1/rake-test
+ * jruby-9.2-pr/rake-test
+ * jruby-9.2/rake-test
+ * ruby-2.5-system/rake-test
+ * ruby-2.5-vendored/rake-test
+ * ruby-2.6-system-pr/rake-test
+ * ruby-2.6-system/rake-test
+ * ruby-2.6-vendored-pr/rake-test
+ * ruby-2.6-vendored/rake-test
 ```
 
 
-### Pruning stalled concourse workers
+### Run a Concourse task with `fly execute`
 
-Especially useful if you're deploying via BOSH, which often results in stalled workers;
+You can `fly execute` a task defined in your pipelines:
 
 ```
-rake concourse:prune-stalled-workers  # prune any stalled workers
+rake concourse:task[job_task,fly_execute_args]  # fly execute the specified task
 ```
 
+where:
 
-## Installation
+* _required_: `job_task` is formatted as `job-name/task-name`, for example, `ruby-2.4/rake-test`. (See `concourse:tasks` for a list of all available task names.)
+* _optional_: `fly_execute_args` will default to map the project directory to a resource with the project name, e.g. `--input=myproject=.`, so your pipeline must name the input resource appropriately in order to use the default.
 
-Add this line to your application's Gemfile:
 
-```ruby
-gem 'concourse'
+### Abort running builds
+
+```
+rake concourse:abort-builds  # abort all running builds for this pipeline
 ```
 
-And then execute:
 
-    $ bundle
+### Prune stalled concourse workers
 
-Or install it yourself as:
+Especially useful if you're deploying via BOSH, which often results in stalled workers;
 
-    $ gem install concourse
+```
+rake concourse:prune-stalled-workers  # prune any stalled workers
+```
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/concourse-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/concourse-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. See [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md).
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). See [`LICENSE.txt`](LICENSE.txt).

data/Rakefile

@@ -4,3 +4,14 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+desc "update README table of contents"
+task :readme_toc => :install_markdown_utils do
+  system "node_modules/.bin/markdown-toc -i --maxdepth 3 README.md"
+end
+
+task :install_markdown_utils do
+  if ! File.exist?("node_modules/.bin/markdown-toc")
+    system "npm install markdown-toc"
+  end
+end

data/lib/concourse.rb

@@ -1,14 +1,12 @@
 require "concourse/version"
+require "concourse/util"
+require "concourse/pipeline"
 require "yaml"
 require "tempfile"
-require 'term/ansicolor'
 
 class Concourse
   include Rake::DSL
-  include Term::ANSIColor
-
-  GITIGNORE_FILE           = ".gitignore"
-  GITATTRIBUTES_FILE       = ".gitattributes"
+  include Concourse::Util
 
   # these numbers/names align with public docker image names
   RUBIES = {
@@ -22,7 +20,7 @@ class Concourse
 
   attr_reader :project_name
   attr_reader :directory
-  attr_reader :pipeline_filename, :pipeline_erb_filename
+  attr_reader :pipelines
   attr_reader :fly_target
   attr_reader :secrets_filename
 
@@ -48,52 +46,39 @@ class Concourse
     RUBIES[:mri].select { |r| r =~ /rc/ }
   end
 
-  def initialize project_name, options={}
+  def initialize project_name, options={}, &block
     @project_name = project_name
 
     @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)
+    base_secrets_filename = options[:secrets_filename] || "private.yml"
     @secrets_filename = File.join(@directory, base_secrets_filename)
-  end
-
-  def erbify document_string, *args
-    ERB.new(document_string, nil, "%-").result(binding)
-  end
-
-  def rake_init
-    FileUtils.mkdir_p File.join(directory, "tasks")
-    FileUtils.touch pipeline_erb_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
+    @pipelines = []
+    if block
+      block.call(self)
+      create_tasks!
+    else
+      add_pipeline(@project_name, (options[:pipeline_erb_filename] || "#{project_name}.yml"))
     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
+  def add_pipeline name, erb_filename
+    @pipelines << Concourse::Pipeline.new(name, @directory, erb_filename)
   end
 
-  def running message
-    print bold, red, "RUNNING: ", reset, message, "\n"
+  def pipeline_subcommands command
+    pipelines.collect { |p| "#{command}:#{p.name}" }
   end
 
-  def note message
-    print bold, green, "NOTE: ", reset, message, "\n"
+  def rake_init
+    FileUtils.mkdir_p File.join(directory, "tasks")
+    pipelines.each do |pipeline|
+      FileUtils.touch pipeline.erb_filename
+      ensure_in_gitignore pipeline.filename
+    end
+    ensure_in_gitignore secrets_filename
   end
 
   def create_tasks!
@@ -101,11 +86,13 @@ class Concourse
       mkdir_p directory
     end
 
-    unless File.exist? pipeline_erb_filename
-      warn "WARNING: concourse template #{pipeline_erb_filename.inspect} does not exist, run `rake concourse:init`"
-    end
+    pipelines.each do |pipeline|
+      CLOBBER.include pipeline.filename if defined?(CLOBBER)
 
-    CLOBBER.include pipeline_filename if defined?(CLOBBER)
+      unless File.exist? pipeline.erb_filename
+        warn "WARNING: concourse template #{pipeline.erb_filename.inspect} does not exist, run `rake concourse:init`"
+      end
+    end
 
     namespace :concourse do
       #
@@ -119,48 +106,67 @@ class Concourse
       #
       #  pipeline commands
       #
-      desc "generate and validate the pipeline file for #{project_name}"
-      task "generate" do |t|
-        File.open pipeline_filename, "w" do |f|
-          f.write erbify(File.read(pipeline_erb_filename))
+      desc "generate and validate all pipeline files"
+      task "generate" => pipeline_subcommands("generate")
+
+      pipelines.each do |pipeline|
+        desc "generate and validate the #{pipeline.name} pipeline file"
+        task "generate:#{pipeline.name}" do
+          File.open pipeline.filename, "w" do |f|
+            f.write erbify(File.read(pipeline.erb_filename))
+          end
+          sh "fly validate-pipeline -c #{pipeline.filename}"
         end
-        sh "fly validate-pipeline -c #{pipeline_filename}"
       end
 
-      desc "upload the pipeline file for #{project_name}"
-      task "set" => ["generate"] do |t, args|
-        options = [
-          "-p '#{project_name}'",
-          "-c '#{pipeline_filename}'",
-        ]
-        if File.exist? secrets_filename
-          note "using #{secrets_filename} to resolve template vars"
-          options << "-l '#{secrets_filename}'"
+      desc "upload all pipeline files"
+      task "set" => pipeline_subcommands("set")
+
+      pipelines.each do |pipeline|
+        desc "upload the #{pipeline.name} pipeline file"
+        task "set:#{pipeline.name}" => "generate:#{pipeline.name}" do
+          options = [
+            "-p '#{pipeline.name}'",
+            "-c '#{pipeline.filename}'",
+          ]
+          if File.exist? secrets_filename
+            note "using #{secrets_filename} to resolve template vars in #{pipeline.filename}"
+            options << "-l '#{secrets_filename}'"
+          end
+          sh "fly -t #{fly_target} set-pipeline #{options.join(" ")}"
         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 do |t, args|
-          sh "fly -t #{fly_target} #{command}-pipeline -p #{project_name}"
+        desc "#{command} all pipelines"
+        task command => pipeline_subcommands(command)
+
+        pipelines.each do |pipeline|
+          desc "#{command} the #{pipeline.name} pipeline"
+          task "#{command}:#{pipeline.name}" do
+            sh "fly -t #{fly_target} #{command}-pipeline -p #{pipeline.name}"
+          end
         end
       end
 
-      desc "remove generate pipeline file"
-      task "clean" do |t|
-        rm_f pipeline_filename
+      desc "remove generated pipeline files"
+      task "clean" do
+        pipelines.each do |pipeline|
+          rm_f pipeline.filename
+        end
       end
 
       #
       #  task commands
       #
-      desc "list all the available tasks from the #{project_name} pipeline"
+      desc "list all the available tasks from the #{project_name} pipelines"
       task "tasks" => "generate" do
         tasks = []
 
-        each_task do |job, task|
-          tasks << "#{job["name"]}/#{task["task"]}"
+        pipelines.each do |pipeline|
+          each_task(pipeline) do |job, task|
+            tasks << "#{job["name"]}/#{task["task"]}"
+          end
         end
 
         note "Available Concourse tasks for #{project_name} are:"
@@ -174,7 +180,7 @@ class Concourse
           raise "ERROR: must specify a task name, like `rake #{t.name}[target,taskname]`"
         end
 
-        concourse_task = find_task job_task
+        concourse_task = find_task(job_task)
         raise "ERROR: could not find task `#{job_task}`" unless concourse_task
 
         fly_execute_args = args[:fly_execute_args] || Concourse.default_execute_args(concourse_task)
@@ -192,7 +198,7 @@ class Concourse
       #
       #  builds commands
       #
-      desc "abort all running builds for this pipeline"
+      desc "abort all running builds for this concourse team"
       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]
@@ -206,7 +212,7 @@ class Concourse
       #  worker commands
       #
       desc "prune any stalled workers"
-      task "prune-stalled-workers" do |t, args|
+      task "prune-stalled-workers" do
         `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}")
@@ -214,28 +220,4 @@ class Concourse
       end
     end
   end
-
-  def each_job
-    pipeline = YAML.load_file(pipeline_filename)
-
-    pipeline["jobs"].each do |job|
-      yield job
-    end
-  end
-
-  def each_task
-    each_job do |job|
-      job["plan"].each do |task|
-        yield job, task if task["task"]
-      end
-    end
-  end
-
-  def find_task job_task
-    job_name, task_name = *job_task.split("/")
-    each_task do |job, task|
-      return task if task["task"] == task_name && job["name"] == job_name
-    end
-    nil
-  end
 end

data/lib/concourse/pipeline.rb

@@ -0,0 +1,12 @@
+class Concourse
+  class Pipeline
+    attr_reader :name, :directory, :erb_filename, :filename
+
+    def initialize name, directory, erb_filename
+      @name = name
+      @directory = directory
+      @erb_filename = File.join(@directory, erb_filename)
+      @filename = File.join(@directory, erb_filename + ".generated")
+    end
+  end
+end

data/lib/concourse/util.rb

@@ -0,0 +1,64 @@
+require 'term/ansicolor'
+
+class Concourse
+  module Util
+    include Term::ANSIColor
+
+    GITIGNORE_FILE           = ".gitignore"
+    GITATTRIBUTES_FILE       = ".gitattributes"
+
+    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 erbify document_string, *args
+      ERB.new(document_string, nil, "%-").result(binding)
+    end
+
+    def each_job pipeline
+      pdata = YAML.load_file(pipeline.filename)
+
+      pdata["jobs"].each do |job|
+        yield job
+      end
+    end
+
+    def each_task pipeline
+      each_job(pipeline) do |job|
+        job["plan"].each do |task|
+          yield job, task if task["task"]
+        end
+      end
+    end
+
+    def find_task job_task
+      job_name, task_name = *job_task.split("/")
+      pipelines.each do |pipeline|
+        each_task(pipeline) do |job, task|
+          return task if task["task"] == task_name && job["name"] == job_name
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/concourse/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -84,6 +84,8 @@ files:
 - Rakefile
 - concourse.gemspec
 - lib/concourse.rb
+- lib/concourse/pipeline.rb
+- lib/concourse/util.rb
 - lib/concourse/version.rb
 homepage: https://github.com/flavorjones/concourse-gem
 licenses: