gitlab-ci-yaml_lint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4f6d9c2aa26ac38285627c6da74edd327b5f126
+  data.tar.gz: 4faab9a496ceafa4375edbc09c25b7e5bbac40e2
+SHA512:
+  metadata.gz: fc20d3ccae4fe802613350771387f7edc9f7e1b1ffc999b3a125fd11143b8aecf9a633a4d04dcf4468f52360e035337d3d016e49f15a8a9876a90881e096a2a8
+  data.tar.gz: 8a98a239d4421d2cfddc06b79076e215fd6d46d8f0aab5a00b8cc1c609a9e1b4d8e606252880139862eb575145b9674343431bd2937bf937405e200a667b695e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gitlab-ci-yaml_lint.gemspec
+gemspec
+
+gem 'pry'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Trevor Vaughan
+
+This package is licensed under the Apache 2.0 license except for items covered
+explicitly under other license terms.
+
+Please see the various files for alternate licenses.
+
+-----
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,50 @@
+# Gitlab::Ci::YamlLint
+
+This gem allows you to run a local validation of your `.gitlab-ci.yml` files.
+
+Rake tasks are additionally include for validating your project
+`.gitlab-ci.yml` files as part of your standard development workflow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitlab-ci-yaml_lint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitlab-ci-yaml_lint
+
+## Usage
+
+You can validate a `.gitlab-ci.yml` file using the `gitlab-ci-yaml_lint`
+application by passing it the path to your local `.gitlab-ci.yml` file.
+
+To use the rake tasks, simply include the following in your project's `Rakefile`:
+
+```ruby
+require 'gitlab/ci/yaml_lint/rake/tasks'
+
+Gitlab::Ci::YamlLint::Rake::Tasks.new(File.dirname(__FILE__))
+```
+
+This will result in tasks being created under the `gitlab_ci` namespace.
+
+You can get a full listing by running `rake -D gitlab_ci`.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trevor-vaughan/gitlab-ci-yaml_lint.

data/Rakefile

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

data/bin/gitlab-ci-yaml_lint

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gitlab/ci/yaml_lint"
+
+infile = ARGV.shift
+
+unless infile
+  $stderr.puts("Usage #{$0} <path/to/.gitlab-ci.yml>")
+  exit 1
+end
+
+Gitlab::Ci::YamlLint.validate(infile)

data/gitlab-ci-yaml_lint.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gitlab/ci/yaml_lint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitlab-ci-yaml_lint"
+  spec.version       = Gitlab::Ci::YamlLint::VERSION
+  spec.authors       = ["Trevor Vaughan"]
+  spec.email         = ["tvaughan@onyxpoint.com"]
+
+  spec.summary       = %q{Validate your gitlab-ci.yml files}
+  spec.homepage      = "https://github.com/trevor-vaughan/rubygem-gitlab-ci-yaml_lint"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", 'gitlab_lib']
+
+  spec.add_runtime_dependency "activesupport", "~> 5.0.6"
+  spec.add_runtime_dependency "activemodel", "~> 5.0.6"
+  spec.add_runtime_dependency "activerecord", "~> 5.0.6"
+  spec.add_runtime_dependency "chronic", "~> 0.10.2"
+  spec.add_runtime_dependency "chronic_duration", "~> 0.10.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/gitlab_lib/LICENSE

@@ -0,0 +1,27 @@
+The files under this directory fall under the following license:
+
+Copyright (c) 2011-2017 GitLab B.V.
+
+With regard to the GitLab Software:
+
+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.
+
+For all third party components incorporated into the GitLab Software, those
+components are licensed under the original license provided by the owner of the
+applicable component.

data/gitlab_lib/gitlab/ci/config.rb

@@ -0,0 +1,62 @@
+module Gitlab
+  module Ci
+    ##
+    # Base GitLab CI Configuration facade
+    #
+    class Config
+      def initialize(config)
+        @config = Loader.new(config).load!
+
+        @global = Entry::Global.new(@config)
+        @global.compose!
+      end
+
+      def valid?
+        @global.valid?
+      end
+
+      def errors
+        @global.errors
+      end
+
+      def to_hash
+        @config
+      end
+
+      ##
+      # Temporary method that should be removed after refactoring
+      #
+      def before_script
+        @global.before_script_value
+      end
+
+      def image
+        @global.image_value
+      end
+
+      def services
+        @global.services_value
+      end
+
+      def after_script
+        @global.after_script_value
+      end
+
+      def variables
+        @global.variables_value
+      end
+
+      def stages
+        @global.stages_value
+      end
+
+      def cache
+        @global.cache_value
+      end
+
+      def jobs
+        @global.jobs_value
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/artifacts.rb

@@ -0,0 +1,35 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a configuration of job artifacts.
+        #
+        class Artifacts < Node
+          include Validatable
+          include Attributable
+
+          ALLOWED_KEYS = %i[name untracked paths when expire_in].freeze
+
+          attributes ALLOWED_KEYS
+
+          validations do
+            validates :config, type: Hash
+            validates :config, allowed_keys: ALLOWED_KEYS
+
+            with_options allow_nil: true do
+              validates :name, type: String
+              validates :untracked, boolean: true
+              validates :paths, array_of_strings: true
+              validates :when,
+                inclusion: { in: %w[on_success on_failure always],
+                             message: 'should be on_success, on_failure ' \
+                                      'or always' }
+              validates :expire_in, duration: true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/attributable.rb

@@ -0,0 +1,27 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        module Attributable
+          extend ActiveSupport::Concern
+
+          class_methods do
+            def attributes(*attributes)
+              attributes.flatten.each do |attribute|
+                if method_defined?(attribute)
+                  raise ArgumentError, 'Method already defined!'
+                end
+
+                define_method(attribute) do
+                  return unless config.is_a?(Hash)
+
+                  config[attribute]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/boolean.rb

@@ -0,0 +1,18 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a boolean value.
+        #
+        class Boolean < Node
+          include Validatable
+
+          validations do
+            validates :config, boolean: true
+          end
+        end
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/cache.rb

@@ -0,0 +1,45 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a cache configuration
+        #
+        class Cache < Node
+          include Configurable
+          include Attributable
+
+          ALLOWED_KEYS = %i[key untracked paths policy].freeze
+          DEFAULT_POLICY = 'pull-push'.freeze
+
+          validations do
+            validates :config, allowed_keys: ALLOWED_KEYS
+            validates :policy, inclusion: { in: %w[pull-push push pull], message: 'should be pull-push, push, or pull' }, allow_blank: true
+          end
+
+          entry :key, Entry::Key,
+            description: 'Cache key used to define a cache affinity.'
+
+          entry :untracked, Entry::Boolean,
+            description: 'Cache all untracked files.'
+
+          entry :paths, Entry::Paths,
+            description: 'Specify which paths should be cached across builds.'
+
+          helpers :key
+
+          attributes :policy
+
+          def value
+            result = super
+
+            result[:key] = key_value
+            result[:policy] = policy || DEFAULT_POLICY
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/commands.rb

@@ -0,0 +1,33 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a job script.
+        #
+        class Commands < Node
+          include Validatable
+
+          validations do
+            include LegacyValidationHelpers
+
+            validate do
+              unless string_or_array_of_strings?(config)
+                errors.add(:config,
+                           'should be a string or an array of strings')
+              end
+            end
+
+            def string_or_array_of_strings?(field)
+              validate_string(field) || validate_array_of_strings(field)
+            end
+          end
+
+          def value
+            Array(@config)
+          end
+        end
+      end
+    end
+  end
+end

data/gitlab_lib/gitlab/ci/config/entry/configurable.rb

@@ -0,0 +1,77 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # This mixin is responsible for adding DSL, which purpose is to
+        # simplifly process of adding child nodes.
+        #
+        # This can be used only if parent node is a configuration entry that
+        # holds a hash as a configuration value, for example:
+        #
+        # job:
+        #   script: ...
+        #   artifacts: ...
+        #
+        module Configurable
+          extend ActiveSupport::Concern
+
+          included do
+            include Validatable
+
+            validations do
+              validates :config, type: Hash
+            end
+          end
+
+          def compose!(deps = nil)
+            return unless valid?
+
+            self.class.nodes.each do |key, factory|
+              factory
+                .value(config[key])
+                .with(key: key, parent: self)
+
+              entries[key] = factory.create!
+            end
+
+            yield if block_given?
+
+            entries.each_value do |entry|
+              entry.compose!(deps)
+            end
+          end
+
+          class_methods do
+            def nodes
+              Hash[(@nodes || {}).map { |key, factory| [key, factory.dup] }]
+            end
+
+            private # rubocop:disable Lint/UselessAccessModifier
+
+            def entry(key, entry, metadata)
+              factory = Entry::Factory.new(entry)
+                .with(description: metadata[:description])
+
+              (@nodes ||= {}).merge!(key.to_sym => factory)
+            end
+
+            def helpers(*nodes)
+              nodes.each do |symbol|
+                define_method("#{symbol}_defined?") do
+                  entries[symbol]&.specified?
+                end
+
+                define_method("#{symbol}_value") do
+                  return unless entries[symbol] && entries[symbol].valid?
+
+                  entries[symbol].value
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end