preflight_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39343dc954e21f4d4cf2b2231f6225ea95de7e4b
+  data.tar.gz: 4d1f5e1a5013bd4e02176145618322bd3e890018
+SHA512:
+  metadata.gz: 4f979fffa1fffed13916d097999af3e40332519414c8c78667edb936337bff049c6fb4423407e6b3b466a91f516cc81ee4a71b0c3866e6da0a8a0a6263b102cb
+  data.tar.gz: d57e7844232c55a44f03dada5e5d3466a71e22c93cf32a8732322bbce4e4720939da758efa8a70dd34633029ae414aa1fbadc0a1c5446ce7f31a2f75468a2894

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    preflight_check (0.0.1)
+      colorize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.7.7)
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  preflight_check!
+  rake (~> 10.0)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Max Gordon
+
+MIT License
+
+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

@@ -0,0 +1,35 @@
+[![Circle CI](https://circleci.com/gh/postazure/preflight_check.svg?style=svg)](https://circleci.com/gh/postazure/preflight_check)
+[![Gem Version](https://badge.fury.io/rb/preflight_check.svg)](https://badge.fury.io/rb/preflight_check)
+
+# PreflightCheck
+
+Validates that you have defined all of the resources that your jobs are depending on.
+Validates that all declared resources are consumed.
+ 
+ ![Success Screenshot](https://github.com/postazure/preflight_check/blob/master/doc-support/success_use_screenshot.png "Success Use")
+ ![Failure Screenshot](https://github.com/postazure/preflight_check/blob/master/doc-support/failure_use_screenshot.png "Failure Use")
+
+## Installation
+
+install it as:
+
+    $ gem install preflight_check
+
+### Usage
+
+    $ preflight_check /path/to/config_file.yml   
+ 
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/preflight_check/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+ 
+## Coming Soon
+
+1. Wrap concourse cli `fly` command to validate then run `fly`
+1. Check that tasks are defined
+1. Check concourse config file structure to ensure everything that is declared exists

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/preflight_check

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+require 'preflight_check'
+
+require 'colorize'
+
+def print_failed_jobs(result)
+  puts "\nMissing Dependencies".underline
+  result.failed_jobs.each do |job|
+    job.missing_dependencies.each do |dep|
+      puts "  Job: '#{job.name}', is missing resource: #{dep.name}"
+    end
+  end
+end
+
+def print_failed_resources(result)
+  puts "\nUnused Resources Declared".underline
+  result.failed_resources.each do |resource|
+    puts "  Resource: '#{resource.name}' was defined, but never used."
+  end
+end
+
+
+def get_manifest_path
+  path = ARGV.first
+  if path.nil? || path.empty?
+    puts 'Include path to yml as command line argument.'.yellow
+    puts 'ie. $ validate_manifest /path/to/file.yml'.yellow
+    exit
+  end
+  path
+end
+
+def run
+  path = get_manifest_path
+  concourse_yml_validator = ConcourseYmlValidator.new
+  result = concourse_yml_validator.validate(path: path)
+  puts "\n"
+  if result.success?
+    puts "SUCCESS, Maifest '#{path}' is valid.".green
+    puts 'You are cleared for takeoff.'
+
+  else
+    puts "FAILURE, Manifest '#{path}' is invalid.".red
+    print_failed_jobs(result) unless result.failed_jobs.empty?
+    print_failed_resources(result) unless result.failed_resources.empty?
+  end
+  puts "\n"
+end
+
+run

data/doc-support/balanced_manifest.yml

@@ -0,0 +1,70 @@
+resources:
+- name: main-project
+  type: git
+  source:
+    uri: git@github.com:something/sample.git
+
+- name: ci-config-repo
+  type: git
+  source:
+    uri: git@github.com:something/sample-other.git
+
+- name: cached-jar-1
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: cached-jar-2
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-1-task
+      file: ci-config-repo/tasks/build-jar-1-task/build-jar-1-task.yml
+    - put: cached-jar-1
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: build-jar-2
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-2-task
+      file: ci-config-repo/tasks/build-jar-2-task/build-jar-2-task.yml
+    - put: cached-jar-2
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: deploy-jar-1
+  plan:
+    - get: main-project
+      passed: [build-jar-1]
+    - get: ci-config-repo
+    - get: cached-jar-1
+      passed: [build-jar-1]
+      trigger: true
+    - task: deploy-jar-1-task
+      file: ci-config-repo/tasks/deploy-jar-1-task/deploy-jar-1-task.yml
+
+- name: deploy-jar-2
+  plan:
+    - get: main-project
+      passed: [deploy-jar-2]
+    - get: ci-config-repo
+    - get: cached-jar-2
+      passed: [deploy-jar-2]
+      trigger: true
+    - task: deploy-jar-2-task
+      file: ci-config-repo/tasks/deploy-jar-2-task/deploy-jar-2-task.yml

data/doc-support/unbalanced_manifest.yml

@@ -0,0 +1,76 @@
+resources:
+- name: main-project
+  type: git
+  source:
+    uri: git@github.com:something/sample.git
+
+- name: ci-config-repo
+  type: git
+  source:
+    uri: git@github.com:something/sample-other.git
+
+- name: cached-jar-1
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: misssssspelled-thingz
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: extra-thing
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-1-task
+      file: ci-config-repo/tasks/build-jar-1-task/build-jar-1-task.yml
+    - put: cached-jar-1
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: build-jar-2
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-2-task
+      file: ci-config-repo/tasks/build-jar-2-task/build-jar-2-task.yml
+    - put: cached-jar-2
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: deploy-jar-1
+  plan:
+    - get: main-project
+      passed: [build-jar-1]
+    - get: ci-config-repo
+    - get: cached-jar-1
+      passed: [build-jar-1]
+      trigger: true
+    - task: deploy-jar-1-task
+      file: ci-config-repo/tasks/deploy-jar-1-task/deploy-jar-1-task.yml
+
+- name: deploy-jar-2
+  plan:
+    - get: main-project
+      passed: [deploy-jar-2]
+    - get: ci-config-repo
+    - get: cached-jar-2
+      passed: [deploy-jar-2]
+      trigger: true
+    - task: deploy-jar-2-task
+      file: ci-config-repo/tasks/deploy-jar-2-task/deploy-jar-2-task.yml

data/lib/preflight_check/concourse_correlator.rb

@@ -0,0 +1,48 @@
+require_relative 'validator_result'
+
+class ConcourseCorrelator
+  def process_jobs(jobs:, resources:)
+
+    jobs.each { |job| mark_missing_dependencies(job, resources) }
+
+    used_resources = build_utilized_resource_list(jobs)
+
+    failed_resources = []
+    resources.each do |resource|
+      consumed_resource = used_resources.find do |used_resource_name|
+        used_resource_name == resource.name
+      end
+      if consumed_resource.nil?
+        failed_resources << resource
+      end
+    end
+
+    failed_jobs = jobs.reject(&:success?)
+    ValidatorResult.new(failed_jobs: failed_jobs, failed_resources: failed_resources)
+  end
+
+  def build_utilized_resource_list(jobs)
+    utilized_resource_names = []
+    jobs.each do |job|
+      job.dependencies.each do |dep|
+        utilized_resource_names << dep.name
+      end
+    end
+    utilized_resource_names
+  end
+
+  def mark_missing_dependencies(job, resources)
+    job.dependencies.each do |dep|
+      if dep_is_defined_as_resource(dep, resources)
+        dep.defined = true
+      else
+        job.mark_as_failed
+        dep.defined = false
+      end
+    end
+  end
+
+  def dep_is_defined_as_resource(dep, resources)
+    resources.find { |resource| resource.name == dep.name }
+  end
+end

data/lib/preflight_check/concourse_job.rb

@@ -0,0 +1,20 @@
+class ConcourseJob
+  attr_accessor :name, :dependencies
+  def initialize(name:, dependencies:)
+    @name = name
+    @dependencies = dependencies
+    @success = true
+  end
+
+  def mark_as_failed
+    @success = false
+  end
+
+  def success?
+    @success
+  end
+
+  def missing_dependencies
+    dependencies.reject(&:defined?)
+  end
+end

data/lib/preflight_check/concourse_job_dependency.rb

@@ -0,0 +1,15 @@
+class ConcourseJobDependency
+  attr_accessor :name
+  def initialize(name:)
+    @name = name
+    @is_defined = nil
+  end
+
+  def defined= value
+    @is_defined = value
+  end
+
+  def defined?
+    @is_defined
+  end
+end

data/lib/preflight_check/concourse_job_factory.rb

@@ -0,0 +1,13 @@
+require_relative 'concourse_job'
+require_relative 'concourse_job_dependency'
+
+class ConcourseJobFactory
+  def build(job_info)
+    dependencies = []
+    job_info['plan'].each do |dependency|
+      name = dependency['get'] || dependency['put']
+      dependencies << ConcourseJobDependency.new(name: name) unless name.nil?
+    end
+    ConcourseJob.new(name: job_info['name'], dependencies: dependencies)
+  end
+end

data/lib/preflight_check/concourse_resource.rb

@@ -0,0 +1,6 @@
+class ConcourseResource
+  attr_accessor :name
+  def initialize(name:)
+    @name = name
+  end
+end

data/lib/preflight_check/concourse_yml_validator.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require_relative 'concourse_resource'
+require_relative 'concourse_job_factory'
+require_relative 'concourse_correlator'
+
+
+class ConcourseYmlValidator
+  def validate(path:)
+    yml_info = read_yml_file(path)
+    resources = init_resources(yml_info['resources'])
+    jobs = init_job(yml_info['jobs'])
+
+    correlator = ConcourseCorrelator.new
+    correlator.process_jobs(jobs: jobs, resources: resources)
+  end
+
+  private
+  def read_yml_file(path)
+    file = File.open(path, 'r')
+    contents = file.read
+    file.close
+
+    YAML.load(contents)
+  end
+
+  def init_resources(yaml_resources)
+    yaml_resources.map do |resource|
+      ConcourseResource.new(name: resource['name'])
+    end
+  end
+
+  def init_job(yaml_job)
+    yaml_job.map do |job|
+      ConcourseJobFactory.new.build(job)
+    end
+  end
+end

data/lib/preflight_check/validator_result.rb

@@ -0,0 +1,12 @@
+class ValidatorResult
+  attr_accessor :failed_jobs, :failed_resources
+
+  def initialize(failed_jobs:, failed_resources:)
+    @failed_jobs = failed_jobs
+    @failed_resources = failed_resources
+  end
+
+  def success?
+    failed_jobs.empty? && failed_resources.empty?
+  end
+end

data/lib/preflight_check/version.rb

@@ -0,0 +1,3 @@
+module PreflightCheck
+  VERSION = "0.1.0"
+end

data/lib/preflight_check.rb

@@ -0,0 +1,7 @@
+require "preflight_check/version"
+require_relative '../lib/preflight_check/concourse_yml_validator'
+
+module PreflightCheck
+  class Validator < ConcourseYmlValidator
+  end
+end

data/preflight_check.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'preflight_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "preflight_check"
+  spec.version       = PreflightCheck::VERSION
+  spec.authors       = ["Max Gordon"]
+  spec.email         = ["gordonmaxc@gmail.com"]
+  spec.summary       = 'Pre-flight check your concourse config yaml before taking off.'
+  spec.description   = "Validates that you have defined all of the resources that your jobs are depending on.\nValidates that all declared resources are consumed."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "colorize"
+end

data/spec/concourse_correlator_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../lib/preflight_check/concourse_yml_validator'
+
+describe ConcourseCorrelator do
+  let(:job_list) { [ConcourseJob.new(name: 'foo_job', dependencies: [ConcourseJobDependency.new(name: 'bar_resource')])] }
+
+  describe '#proccess_jobs' do
+
+    context 'when jobs and resources match' do
+      let(:resource_list) { [ConcourseResource.new(name: 'bar_resource')] }
+
+      it 'should ensure that each job has all the dependencies that it specifies' do
+        expect(subject.process_jobs(jobs: job_list, resources: resource_list)).to be_a ValidatorResult
+      end
+    end
+
+    context 'when resources are missing' do
+      let(:resource_list) { [] }
+
+      it 'should ensure that each job has all the dependencies that it specifies' do
+        result = subject.process_jobs(jobs: job_list, resources: resource_list)
+        expect(result.success?).to be false
+
+        job = result.failed_jobs.first
+        expect(job.name).to eq 'foo_job'
+
+        missing_dep = job.missing_dependencies.first
+        expect(missing_dep.name).to eq 'bar_resource'
+      end
+    end
+
+    context 'when there are extra resources' do
+      let(:resource_list) do
+        [
+            ConcourseResource.new(name: 'bar_resource'),
+            ConcourseResource.new(name: 'extra-resource')
+        ]
+      end
+
+      it 'should ensure that all resources are used by jobs' do
+        result = subject.process_jobs(jobs: job_list, resources: resource_list)
+
+        expect(result.success?).to be false
+        expect(result.failed_resources.length).to eq 1
+
+        failed_resource = result.failed_resources.first
+        expect(failed_resource.name).to eq 'extra-resource'
+      end
+    end
+  end
+end

data/spec/concourse_job_factory_spec.rb

@@ -0,0 +1,45 @@
+describe ConcourseJobFactory do
+  describe '#build' do
+
+    context 'when "get"' do
+      let(:jobs_yml) do
+        <<-YML
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+        YML
+      end
+      it 'should build' do
+        job = subject.build(YAML.load(jobs_yml)['jobs'].first)
+
+        expect(job.name).to eq 'build-jar-1'
+
+        resource = job.dependencies.first
+        expect(resource.name).to eq 'ci-config-repo'
+      end
+    end
+
+    context 'when "put"' do
+      let(:jobs_yml) do
+        <<-YML
+jobs:
+- name: build-jar-1
+  plan:
+    - put: ci-config-repo
+      trigger: true
+        YML
+      end
+
+      it 'should build' do
+        job = subject.build(YAML.load(jobs_yml)['jobs'].first)
+
+        expect(job.name).to eq 'build-jar-1'
+
+        resource = job.dependencies.first
+        expect(resource.name).to eq 'ci-config-repo'
+      end
+    end
+  end
+end

data/spec/concourse_yml_validator_spec.rb

@@ -0,0 +1,50 @@
+describe ConcourseYmlValidator do
+  context 'when jobs have all their resources' do
+    let(:path_to_manifest) { File.join(File.dirname(__FILE__), 'support/yml_with_balanced_resources.yml') }
+
+    it 'should return a ValidatorResult' do
+      validator_result = subject.validate(path: path_to_manifest)
+      expect(validator_result).to be_a ValidatorResult
+    end
+
+    it 'should validate that all the "resources" exist for all the "jobs"' do
+      validator_result = subject.validate(path: path_to_manifest)
+      expect(validator_result.success?).to be true
+    end
+  end
+
+  context 'when jobs are missing resources' do
+    let(:path_to_manifest) { File.join(File.dirname(__FILE__), 'support/yml_with_missing_resources.yml') }
+
+    it 'should validate that all the "resources" exist for all the "jobs"' do
+      validator_result = subject.validate(path: path_to_manifest)
+      expect(validator_result.success?).to be false
+    end
+
+    it 'should have a result failed jobs with their missing deps marked' do
+      validator_result = subject.validate(path: path_to_manifest)
+
+      expect(validator_result.failed_jobs.size).to eq 2
+      expect(validator_result.failed_jobs.map(&:name)).to contain_exactly('build-jar-2', 'deploy-jar-2')
+      expect(validator_result.failed_jobs[0].missing_dependencies.first.name).to eq 'cached-jar-2'
+      expect(validator_result.failed_jobs[1].missing_dependencies.first.name).to eq 'cached-jar-2'
+    end
+  end
+
+  context 'when there are extra resources defined' do
+    let(:path_to_manifest) { File.join(File.dirname(__FILE__), 'support/yml_with_extra_resources.yml') }
+
+    it 'should fail because there are resources that are defined and not used' do
+      validator_result = subject.validate(path: path_to_manifest)
+      expect(validator_result.success?).to be false
+    end
+
+    it 'should have a result that includes extra resources' do
+      validator_result = subject.validate(path: path_to_manifest)
+
+      expect(validator_result.failed_resources.size).to eq 1
+      failed_resource = validator_result.failed_resources.first
+      expect(failed_resource.name).to eq 'extra-resource'
+    end
+  end
+end

data/spec/preflight_check_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe PreflightCheck do
+  it 'has a version number' do
+    expect(PreflightCheck::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'preflight_check'

data/spec/support/yml_with_balanced_resources.yml

@@ -0,0 +1,70 @@
+resources:
+- name: main-project
+  type: git
+  source:
+    uri: git@github.com:something/sample.git
+
+- name: ci-config-repo
+  type: git
+  source:
+    uri: git@github.com:something/sample-other.git
+
+- name: cached-jar-1
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: cached-jar-2
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-1-task
+      file: ci-config-repo/tasks/build-jar-1-task/build-jar-1-task.yml
+    - put: cached-jar-1
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: build-jar-2
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-2-task
+      file: ci-config-repo/tasks/build-jar-2-task/build-jar-2-task.yml
+    - put: cached-jar-2
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: deploy-jar-1
+  plan:
+    - get: main-project
+      passed: [build-jar-1]
+    - get: ci-config-repo
+    - get: cached-jar-1
+      passed: [build-jar-1]
+      trigger: true
+    - task: deploy-jar-1-task
+      file: ci-config-repo/tasks/deploy-jar-1-task/deploy-jar-1-task.yml
+
+- name: deploy-jar-2
+  plan:
+    - get: main-project
+      passed: [deploy-jar-2]
+    - get: ci-config-repo
+    - get: cached-jar-2
+      passed: [deploy-jar-2]
+      trigger: true
+    - task: deploy-jar-2-task
+      file: ci-config-repo/tasks/deploy-jar-2-task/deploy-jar-2-task.yml

data/spec/support/yml_with_extra_resources.yml

@@ -0,0 +1,76 @@
+resources:
+- name: main-project
+  type: git
+  source:
+    uri: git@github.com:something/sample.git
+
+- name: ci-config-repo
+  type: git
+  source:
+    uri: git@github.com:something/sample-other.git
+
+- name: cached-jar-1
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: cached-jar-2
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+- name: extra-resource
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-1-task
+      file: ci-config-repo/tasks/build-jar-1-task/build-jar-1-task.yml
+    - put: cached-jar-1
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: build-jar-2
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-2-task
+      file: ci-config-repo/tasks/build-jar-2-task/build-jar-2-task.yml
+    - put: cached-jar-2
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: deploy-jar-1
+  plan:
+    - get: main-project
+      passed: [build-jar-1]
+    - get: ci-config-repo
+    - get: cached-jar-1
+      passed: [build-jar-1]
+      trigger: true
+    - task: deploy-jar-1-task
+      file: ci-config-repo/tasks/deploy-jar-1-task/deploy-jar-1-task.yml
+
+- name: deploy-jar-2
+  plan:
+    - get: main-project
+      passed: [deploy-jar-2]
+    - get: ci-config-repo
+    - get: cached-jar-2
+      passed: [deploy-jar-2]
+      trigger: true
+    - task: deploy-jar-2-task
+      file: ci-config-repo/tasks/deploy-jar-2-task/deploy-jar-2-task.yml

data/spec/support/yml_with_missing_resources.yml

@@ -0,0 +1,71 @@
+resources:
+- name: main-project
+  type: git
+  source:
+    uri: git@github.com:something/sample.git
+
+- name: ci-config-repo
+  type: git
+  source:
+    uri: git@github.com:something/sample-other.git
+
+- name: cached-jar-1
+  type: s3
+  source:
+    bucket: concourse-instance-name
+    versioned_file: cached-jar-1.jar
+
+# MISSING RESOURCE
+#- name: cached-jar-2
+#  type: s3
+#  source:
+#    bucket: concourse-instance-name
+#    versioned_file: cached-jar-1.jar
+
+
+jobs:
+- name: build-jar-1
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-1-task
+      file: ci-config-repo/tasks/build-jar-1-task/build-jar-1-task.yml
+    - put: cached-jar-1
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: build-jar-2
+  plan:
+    - get: ci-config-repo
+      trigger: true
+    - get: main-project
+      trigger: true
+    - task: build-jar-2-task
+      file: ci-config-repo/tasks/build-jar-2-task/build-jar-2-task.yml
+    - put: cached-jar-2
+      params:
+        file: jar/project-0.0.1-SNAPSHOT.jar
+
+- name: deploy-jar-1
+  plan:
+    - get: main-project
+      passed: [build-jar-1]
+    - get: ci-config-repo
+    - get: cached-jar-1
+      passed: [build-jar-1]
+      trigger: true
+    - task: deploy-jar-1-task
+      file: ci-config-repo/tasks/deploy-jar-1-task/deploy-jar-1-task.yml
+
+- name: deploy-jar-2
+  plan:
+    - get: main-project
+      passed: [deploy-jar-2]
+    - get: ci-config-repo
+    - get: cached-jar-2
+      passed: [deploy-jar-2]
+      trigger: true
+    - task: deploy-jar-2-task
+      file: ci-config-repo/tasks/deploy-jar-2-task/deploy-jar-2-task.yml

data/spec/validator_result_spec.rb

@@ -0,0 +1,39 @@
+describe ValidatorResult do
+  let(:a_resource) { ConcourseResource.new(name: 'foo') }
+
+  let( :failed_job ) do
+    ConcourseJob.new(
+        name: 'failed job', dependencies: [ConcourseJobDependency.new(name: 'not defined')]
+    )
+  end
+
+  describe '#success?' do
+    it 'should return true when there are no failed jobs' do
+      result = ValidatorResult.new(failed_jobs: [], failed_resources: [])
+      expect(result).to be_success
+    end
+
+    it 'should return false when there are failed jobs' do
+      result = ValidatorResult.new(failed_jobs: [failed_job], failed_resources: [])
+      expect(result).to_not be_success
+    end
+
+    it 'should return false when there are failed resources' do
+      result = ValidatorResult.new(failed_jobs: [], failed_resources: [a_resource])
+      expect(result).to_not be_success
+    end
+
+    it 'should return false when there are both failed resources and failed jobs' do
+      result = ValidatorResult.new(failed_jobs: [failed_job], failed_resources: [a_resource])
+      expect(result).to_not be_success
+    end
+  end
+
+  describe '#failed_jobs' do
+    it 'should return a list of all jobs that are missing dependencies' do
+      result = ValidatorResult.new(failed_jobs: [failed_job], failed_resources: [])
+
+      expect(result.failed_jobs).to contain_exactly failed_job
+    end
+  end
+end

data/validate_manifest.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'colorize'
+require_relative './lib/preflight_check/concourse_yml_validator'
+
+def print_failed_jobs(result)
+  puts "\nMissing Dependencies".underline
+  result.failed_jobs.each do |job|
+    job.missing_dependencies.each do |dep|
+      puts "  Job: '#{job.name}', is missing resource: #{dep.name}"
+    end
+  end
+end
+
+def print_failed_resources(result)
+  puts "\nUnused Resources Declared".underline
+  result.failed_resources.each do |resource|
+    puts "  Resource: '#{resource.name}' was defined, but never used."
+  end
+end
+
+
+def get_manifest_path
+  path = ARGV.first
+  if path.nil? || path.empty?
+    puts 'Include path to yml as command line argument.'.yellow
+    puts 'ie. $ validate_manifest /path/to/file.yml'.yellow
+    exit
+  end
+  path
+end
+
+def run
+  path = get_manifest_path
+  concourse_yml_validator = ConcourseYmlValidator.new
+  result = concourse_yml_validator.validate(path: path)
+  puts "\n"
+  if result.success?
+    puts "SUCCESS, Maifest '#{path}' is valid.".green
+    puts 'You are cleared for takeoff.'
+
+  else
+    puts "FAILURE, Manifest '#{path}' is invalid.".red
+    print_failed_jobs(result) unless result.failed_jobs.empty?
+    print_failed_resources(result) unless result.failed_resources.empty?
+  end
+  puts "\n"
+end
+
+run

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: preflight_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Gordon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+description: |-
+  Validates that you have defined all of the resources that your jobs are depending on.
+  Validates that all declared resources are consumed.
+email:
+- gordonmaxc@gmail.com
+executables:
+- preflight_check
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/preflight_check
+- doc-support/balanced_manifest.yml
+- doc-support/failure_use_screenshot.png
+- doc-support/success_use_screenshot.png
+- doc-support/unbalanced_manifest.yml
+- lib/preflight_check.rb
+- lib/preflight_check/concourse_correlator.rb
+- lib/preflight_check/concourse_job.rb
+- lib/preflight_check/concourse_job_dependency.rb
+- lib/preflight_check/concourse_job_factory.rb
+- lib/preflight_check/concourse_resource.rb
+- lib/preflight_check/concourse_yml_validator.rb
+- lib/preflight_check/validator_result.rb
+- lib/preflight_check/version.rb
+- preflight_check.gemspec
+- spec/concourse_correlator_spec.rb
+- spec/concourse_job_factory_spec.rb
+- spec/concourse_yml_validator_spec.rb
+- spec/preflight_check_spec.rb
+- spec/spec_helper.rb
+- spec/support/yml_with_balanced_resources.yml
+- spec/support/yml_with_extra_resources.yml
+- spec/support/yml_with_missing_resources.yml
+- spec/validator_result_spec.rb
+- validate_manifest.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pre-flight check your concourse config yaml before taking off.
+test_files:
+- spec/concourse_correlator_spec.rb
+- spec/concourse_job_factory_spec.rb
+- spec/concourse_yml_validator_spec.rb
+- spec/preflight_check_spec.rb
+- spec/spec_helper.rb
+- spec/support/yml_with_balanced_resources.yml
+- spec/support/yml_with_extra_resources.yml
+- spec/support/yml_with_missing_resources.yml
+- spec/validator_result_spec.rb