travis-lint 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+#~
+*~
+Gemfile.lock
+*.gem
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format
+progress

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-head
+  - ruby-head
+  - 1.8.7
+script: bundle exec rspec -c spec
+notifications:
+  irc: "irc.freenode.org#travis"
+  email:
+    recepients:
+      - michaelklishin@me.com
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rake", ">= 0.9.2.2"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT LICENSE
+
+Copyright (c) 2012 Travis CI Development Team <contact@travis-ci.org>
+
+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,36 @@
+# What is travis-lint
+
+`travis-lint` is a tool that checks your `.travis.yml` file for possible issues, deprecations and so on.
+
+[![Continuous Integration status](https://secure.travis-ci.org/travis-ci/travis-lint.png)](http://travis-ci.org/travis-ci/travis-lint)
+
+
+## Installation
+
+TBD: we need to do initial gem release first
+
+
+## Usage
+
+    travis-lint ./.travis.yml
+    travis-lint ~/your/project/.travis.yml
+
+
+## Development
+
+Install dependencies with
+
+    bundle install
+
+then run tests with
+
+    bundle exec rspec spec
+
+Once you are done with your changes, push a branch and submit a pull request.
+
+
+## License & Copyright
+
+Copyright 2012 (c) Travis CI Development Team.
+
+Released under the MIT license.

data/bin/travis-lint

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'travis/lint'
+
+  runner = Travis::Lint::Runner.new(ARGV)
+  runner.run
+rescue LoadError => e
+  $stderr.puts <<-EOS
+#{'*'*50}
+  Could not find 'travis/lint'
+
+  This may happen if you're using rubygems as your package manager, but it is not
+  being required through some mechanism before executing the travis-lint command.
+
+  You may need to do one of the following in your shell:
+
+    # for bash/zsh
+    export RUBYOPT=rubygems
+
+    # for csh, etc.
+    set RUBYOPT=rubygems
+
+  For background, please see http://gist.github.com/54177.
+#{'*'*50}
+  EOS
+
+  raise e
+
+  exit(1)
+end

data/lib/travis/lint.rb

@@ -0,0 +1,4 @@
+require "travis/lint/version"
+
+require "travis/lint/runner"
+require "travis/lint/linter"

data/lib/travis/lint/dsl.rb

@@ -0,0 +1,26 @@
+require "travis/lint/validator"
+
+module Travis
+  module Lint
+    module DSL
+      @@validators = []
+
+      def validator_for(language, key, message, &validator)
+        @@validators << Validator.new(language, key, message, validator)
+      end
+
+
+      def validators_for_language(language)
+        @@validators.select { |v| v.language.to_s.downcase == language.to_s.downcase }
+      end
+
+      def generic_validators
+        @@validators.select { |v| v.language.to_s.downcase == :all.to_s }
+      end
+
+      def find_validators_for(language)
+        generic_validators + validators_for_language(language)
+      end
+    end
+  end
+end

data/lib/travis/lint/linter.rb

@@ -0,0 +1,88 @@
+require "active_support/core_ext/object/blank"
+require "travis/lint/dsl"
+
+module Travis
+  module Lint
+    class Linter
+
+      #
+      # Behaviors
+      #
+
+      extend Lint::DSL
+
+
+      #
+      # API
+      #
+
+      def self.validate(hsh)
+        issues = find_validators_for(hsh[:language]).inject([]) do |acc, val|
+          acc << val.call(hsh)
+          acc
+        end.reject(&:first).map { |pair| pair[1] }
+      end
+
+      def self.valid?(hsh)
+        validate(hsh).empty?
+      end
+
+
+      #
+      # General
+      #
+
+      validator_for :all, :language, "Language: key is mandatory" do |hsh|
+        hsh[:language].blank?
+      end
+
+
+      #
+      # Erlang
+      #
+
+      validator_for :erlang, :otp_release, "Specify OTP releases you want to test against using the :otp_release key" do |hsh|
+        hsh[:language].to_s.downcase == "erlang" && hsh[:otp_release].blank?
+      end
+
+
+      #
+      # Ruby
+      #
+
+      validator_for :ruby, :rvm, "Specify Ruby versions/implementations you want to test against using the :rvm key" do |hsh|
+        hsh[:language].to_s.downcase == "ruby" && hsh[:rvm].blank?
+      end
+
+      validator_for :ruby, :rvm, "Prefer jruby-18mode RVM alias to jruby" do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("jruby")
+      end
+
+      validator_for :ruby, :rvm, "Prefer rbx-18mode RVM alias to rbx" do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("rbx")
+      end
+
+      validator_for :ruby, :rvm, "rbx-2.0 RVM alias is no longer provided. Please use rbx-18mode or rbx-19mode instead." do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("rbx-2.0")
+      end
+
+      validator_for :ruby, :rvm, "rbx-2.0.0pre RVM alias is no longer provided. Please use rbx-18mode or rbx-19mode instead." do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("rbx-2.0.0pre")
+      end
+
+      validator_for :ruby, :rvm, "Ruby 1.9.1 is no longer maintained and is no longer provided on travis-ci.org. Please move to 1.9.3." do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("1.9.1")
+      end
+
+      validator_for :ruby, :rvm, "Ruby 1.8.6 is no longer maintained and is no longer provided on travis-ci.org. Please move to 1.8.7." do |hsh|
+        hsh[:rvm].is_a?(Array) && hsh[:rvm].include?("1.8.6")
+      end
+
+
+
+      validator_for :ruby, :language, "Language is set to Ruby but node_js key is present. Ruby builder will ignore node_js key." do |hsh|
+        hsh[:language].to_s.downcase == "ruby" && hsh[:node_js].present?
+      end
+    end
+  end
+end

data/lib/travis/lint/runner.rb

@@ -0,0 +1,79 @@
+require "pathname"
+require "yaml"
+
+require "hashr"
+
+require "travis/lint/linter"
+
+module Travis
+  module Lint
+
+    class Runner
+      def initialize(argv)
+        if argv.empty?
+          if File.exists?(".travis.yml")
+            argv = [".travis.yml"]
+          else
+            show_help
+          end
+        end
+
+        @travis_file_path = Pathname.new(argv.first).expand_path
+      end
+
+
+      def run
+        check_that_travis_yml_file_exists!
+        check_that_travis_yml_file_is_valid_yaml!
+
+        if (issues = Linter.validate(self.parsed_travis_yml)).empty?
+          puts "Hooray, .travis.yml at #{@travis_file_path} seems to be solid!"
+        else
+          issues.each do |i|
+            puts "Found an issue with the `#{i[:key]}:` key:\n\n\t#{i[:issue]}"
+            puts
+            puts
+          end
+        end
+      end
+
+
+      protected
+
+      def check_that_travis_yml_file_exists!
+        quit("Cannot read #{@travis_file_path}: file does not exist or is not readable") unless File.exists?(@travis_file_path) &&
+          File.file?(@travis_file_path) &&
+          File.readable?(@travis_file_path)
+      end
+
+      def check_that_travis_yml_file_is_valid_yaml!
+        begin
+          YAML.load_file(@travis_file_path)
+        rescue ArgumentError, Psych::SyntaxError => e
+          quit ".travis.yml at #{@travis_file_path} is not a valid YAML file and thus will be ignored by Travis CI."
+        end
+      end
+
+      def parsed_travis_yml
+        Hashr.new(YAML.load_file(@travis_file_path))
+      end
+
+      def show_help
+        puts <<-EOS
+Usage:
+
+    travis-lint [path to your .travis.yml]
+      EOS
+
+        exit(1)
+      end
+
+      def quit(message, status = 1)
+        puts message
+        puts
+
+        exit(status)
+      end
+    end
+  end
+end

data/lib/travis/lint/validator.rb

@@ -0,0 +1,15 @@
+module Travis
+  module Lint
+    module DSL
+      class Validator < Struct.new(:language, :key, :message, :validator)
+        def call(hash)
+          if self.validator.call(hash)
+            [false, { :key => self.key, :issue => self.message }]
+          else
+            [true, {}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/travis/lint/version.rb

@@ -0,0 +1,6 @@
+module Travis
+  module Lint
+    VERSION = "1.0.0"
+    Version = VERSION
+  end
+end

data/spec/files/no_language_key.yml

@@ -0,0 +1,16 @@
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+gemfile:
+  - Gemfile
+  - gemfiles/eventmachine-pre
+notifications:
+  recipients:
+    - recepient@example.com
+branches:
+  only:
+    - master
+    - 0.9.x-stable
+    - 0.8.x-stable
+    - 0.7.x-stable

data/spec/files/no_rvm_key.yml

@@ -0,0 +1 @@
+language: ruby

data/spec/files/uses_jruby_instead_of_jruby_in_specific_mode.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - jruby
+  - rbx-2.0.0pre

data/spec/files/uses_old_rbx_aliases.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - rbx-2.0
+  - rbx-2.0.0pre

data/spec/files/uses_ruby_as_language_but_tries_to_switch_nodejs.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+node_js:
+  - 0.6

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: binary
+require "pathname"
+
+require 'bundler'
+Bundler.setup(:default, :test)
+
+require 'rspec'
+
+
+$: << File.expand_path('../../lib', __FILE__)
+require "travis/lint"

data/spec/travis_lint_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+
+describe "A .travis.yml" do
+  let(:language_key_is_mandatory) do
+    { :key => :language, :issue => "Language: key is mandatory" }
+  end
+
+  let(:rvm_key_is_recommended) do
+    { :key => :rvm, :issue => "Specify Ruby versions/implementations you want to test against using the :rvm key" }
+  end
+
+  let(:prefer_jruby18mode_over_jruby) do
+    { :key => :rvm, :issue => "Prefer jruby-18mode RVM alias to jruby" }
+  end
+
+  let(:prefer_rbx18mode_over_rbx) do
+    { :key => :rvm, :issue => "Prefer rbx-18mode RVM alias to rbx" }
+  end
+
+  let(:rbx20_is_no_longer_provided) do
+    { :key => :rvm, :issue => "rbx-2.0 RVM alias is no longer provided. Please use rbx-18mode or rbx-19mode instead." }
+  end
+
+  let(:rbx200pre_is_no_longer_provided) do
+    { :key => :rvm, :issue => "rbx-2.0.0pre RVM alias is no longer provided. Please use rbx-18mode or rbx-19mode instead." }
+  end
+
+
+  def content_of_sample_file(name)
+    path = Pathname.new(File.join("spec", "files", name)).expand_path
+
+    Hashr.new(YAML.load_file(path.to_s))
+  end
+
+
+  context "that is blank" do
+    it "is invalid" do
+      Travis::Lint::Linter.validate({}).should include(language_key_is_mandatory)
+
+      Travis::Lint::Linter.valid?(content_of_sample_file("no_language_key.yml")).should be_false
+    end
+  end
+
+  context "that has language set to Ruby" do
+    context "but has no :rvm key" do
+      it "is invalid" do
+        Travis::Lint::Linter.validate({ :language => "ruby" }).should include(rvm_key_is_recommended)
+        Travis::Lint::Linter.valid?(content_of_sample_file("no_rvm_key.yml")).should be_false
+      end
+    end
+
+
+    context "and uses jruby instead of jruby-18mode" do
+      let(:travis_yml) do
+        { :language => "ruby", :rvm => ["jruby"] }
+      end
+
+      it "is invalid" do
+        Travis::Lint::Linter.validate(travis_yml).should include(prefer_jruby18mode_over_jruby)
+        Travis::Lint::Linter.valid?(content_of_sample_file("uses_jruby_instead_of_jruby_in_specific_mode.yml")).should be_false
+      end
+    end
+
+
+    context "and uses rbx instead of rbx-18mode" do
+      let(:travis_yml) do
+        { :language => "ruby", :rvm => ["rbx", "1.9.3"] }
+      end
+
+      it "is invalid" do
+        Travis::Lint::Linter.validate(travis_yml).should include(prefer_rbx18mode_over_rbx)
+      end
+    end
+
+
+    context "and uses rbx-2.0 instead of rbx-18mode" do
+      let(:travis_yml) do
+        { :language => "ruby", :rvm => ["rbx-2.0", "1.9.3"] }
+      end
+
+      it "is invalid" do
+        Travis::Lint::Linter.validate(travis_yml).should include(rbx20_is_no_longer_provided)
+        Travis::Lint::Linter.valid?(content_of_sample_file("uses_old_rbx_aliases.yml")).should be_false
+      end
+    end
+
+
+    context "and uses rbx-2.0.0pre instead of rbx-18mode" do
+      let(:travis_yml) do
+        { :language => "ruby", :rvm => ["rbx-2.0.0pre", "1.9.3"] }
+      end
+
+      it "is invalid" do
+        Travis::Lint::Linter.validate(travis_yml).should include(rbx200pre_is_no_longer_provided)
+      end
+    end
+
+
+    context "that specifies Ruby as the language but tries to set node_js version" do
+      let(:travis_yml) do
+        { :language => "ruby", :rvm => ["1.9.3"], :node_js => ["0.6"] }
+      end
+
+      it "is invalid" do
+        Travis::Lint::Linter.validate(travis_yml).should include({ :key => :language, :issue => "Language is set to Ruby but node_js key is present. Ruby builder will ignore node_js key." })
+      end
+    end
+  end
+end

data/travis-lint.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "travis/lint/version"
+
+Gem::Specification.new do |s|
+  s.name        = "travis-lint"
+  s.version     = Travis::Lint::Version.to_s
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael S. Klishin", "Travis CI Development Team"]
+  s.email       = ["michaelklishin@me.com", "michael@novemberain.com"]
+  s.homepage    = "http://github.com/travis-ci"
+  s.summary     = %q{Checks your .travis.yml for possible issues, deprecations and so on}
+  s.description = %q{travis-lint is a tool that check your .travis.yml for possible issues, deprecations and so on. Recommended for all travis-ci.org users.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("activesupport", ["~> 3.2.0"])
+  # activesupport 3.1 and 3.2 have a bug in HashWithIndifferentAccess that
+  # causes an undefined method exception when hash values are arrays, so we
+  # retreat to Hashr. MK.
+  s.add_runtime_dependency("hashr", [">= 0.0.19"])
+
+  s.add_development_dependency("rspec", ["~> 2.8.0"])
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: travis-lint
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Michael S. Klishin
+- Travis CI Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 0
+        - 19
+        version: 0.0.19
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+description: travis-lint is a tool that check your .travis.yml for possible issues, deprecations and so on. Recommended for all travis-ci.org users.
+email: 
+- michaelklishin@me.com
+- michael@novemberain.com
+executables: 
+- travis-lint
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- bin/travis-lint
+- lib/travis/lint.rb
+- lib/travis/lint/dsl.rb
+- lib/travis/lint/linter.rb
+- lib/travis/lint/runner.rb
+- lib/travis/lint/validator.rb
+- lib/travis/lint/version.rb
+- spec/files/no_language_key.yml
+- spec/files/no_rvm_key.yml
+- spec/files/uses_jruby_instead_of_jruby_in_specific_mode.yml
+- spec/files/uses_old_rbx_aliases.yml
+- spec/files/uses_ruby_as_language_but_tries_to_switch_nodejs.yml
+- spec/spec_helper.rb
+- spec/travis_lint_spec.rb
+- travis-lint.gemspec
+homepage: http://github.com/travis-ci
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Checks your .travis.yml for possible issues, deprecations and so on
+test_files: 
+- spec/files/no_language_key.yml
+- spec/files/no_rvm_key.yml
+- spec/files/uses_jruby_instead_of_jruby_in_specific_mode.yml
+- spec/files/uses_old_rbx_aliases.yml
+- spec/files/uses_ruby_as_language_but_tries_to_switch_nodejs.yml
+- spec/spec_helper.rb
+- spec/travis_lint_spec.rb