gitlab-ci-yaml_lint 0.1.0

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

@@ -0,0 +1,52 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a set of jobs.
+        #
+        class Jobs < Node
+          include Validatable
+
+          validations do
+            validates :config, type: Hash
+
+            validate do
+              unless has_visible_job?
+                errors.add(:config, 'should contain at least one visible job')
+              end
+            end
+
+            def has_visible_job?
+              config.any? { |name, _| !hidden?(name) }
+            end
+          end
+
+          def hidden?(name)
+            name.to_s.start_with?('.')
+          end
+
+          def compose!(deps = nil)
+            super do
+              @config.each do |name, config|
+                node = hidden?(name) ? Entry::Hidden : Entry::Job
+
+                factory = Entry::Factory.new(node)
+                  .value(config || {})
+                  .metadata(name: name)
+                  .with(key: name, parent: self,
+                        description: "#{name} job definition.")
+
+                @entries[name] = factory.create!
+              end
+
+              @entries.each_value do |entry|
+                entry.compose!(deps)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a key.
+        #
+        class Key < Node
+          include Validatable
+
+          validations do
+            validates :config, key: true
+          end
+
+          def self.default
+            'default'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        module LegacyValidationHelpers
+          private
+
+          def validate_duration(value)
+            value.is_a?(String) && ChronicDuration.parse(value)
+          rescue ChronicDuration::DurationParseError
+            false
+          end
+
+          def validate_array_of_strings(values)
+            values.is_a?(Array) && values.all? { |value| validate_string(value) }
+          end
+
+          def validate_array_of_strings_or_regexps(values)
+            values.is_a?(Array) && values.all? { |value| validate_string_or_regexp(value) }
+          end
+
+          def validate_variables(variables)
+            variables.is_a?(Hash) &&
+              variables.flatten.all? do |value|
+                validate_string(value) || validate_integer(value)
+              end
+          end
+
+          def validate_integer(value)
+            value.is_a?(Integer)
+          end
+
+          def validate_string(value)
+            value.is_a?(String) || value.is_a?(Symbol)
+          end
+
+          def validate_regexp(value)
+            !value.nil? && Regexp.new(value.to_s) && true
+          rescue RegexpError, TypeError
+            false
+          end
+
+          def validate_string_or_regexp(value)
+            return true if value.is_a?(Symbol)
+            return false unless value.is_a?(String)
+
+            if value.first == '/' && value.last == '/'
+              validate_regexp(value[1...-1])
+            else
+              true
+            end
+          end
+
+          def validate_boolean(value)
+            value.in?([true, false])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Base abstract class for each configuration entry node.
+        #
+        class Node
+          InvalidError = Class.new(StandardError)
+
+          attr_reader :config, :metadata
+          attr_accessor :key, :parent, :description
+
+          def initialize(config, **metadata)
+            @config = config
+            @metadata = metadata
+            @entries = {}
+
+            self.class.aspects.to_a.each do |aspect|
+              instance_exec(&aspect)
+            end
+          end
+
+          def [](key)
+            @entries[key] || Entry::Undefined.new
+          end
+
+          def compose!(deps = nil)
+            return unless valid?
+
+            yield if block_given?
+          end
+
+          def leaf?
+            @entries.none?
+          end
+
+          def descendants
+            @entries.values
+          end
+
+          def ancestors
+            @parent ? @parent.ancestors + [@parent] : []
+          end
+
+          def valid?
+            errors.none?
+          end
+
+          def errors
+            []
+          end
+
+          def value
+            if leaf?
+              @config
+            else
+              meaningful = @entries.select do |_key, value|
+                value.specified? && value.relevant?
+              end
+
+              Hash[meaningful.map { |key, entry| [key, entry.value] }]
+            end
+          end
+
+          def specified?
+            true
+          end
+
+          def relevant?
+            true
+          end
+
+          def location
+            name = @key.presence || self.class.name.to_s.demodulize
+                                        .underscore.humanize.downcase
+
+            ancestors.map(&:key).append(name).compact.join(':')
+          end
+
+          def inspect
+            val = leaf? ? config : descendants
+            unspecified = specified? ? '' : '(unspecified) '
+            "#<#{self.class.name} #{unspecified}{#{key}: #{val.inspect}}>"
+          end
+
+          def self.default
+          end
+
+          def self.aspects
+            @aspects ||= []
+          end
+
+          private
+
+          attr_reader :entries
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents an array of paths.
+        #
+        class Paths < Node
+          include Validatable
+
+          validations do
+            validates :config, array_of_strings: true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents an only/except trigger policy for the job.
+        #
+        class Policy < Simplifiable
+          strategy :RefsPolicy, if: -> (config) { config.is_a?(Array) }
+          strategy :ComplexPolicy, if: -> (config) { config.is_a?(Hash) }
+
+          class RefsPolicy < Entry::Node
+            include Entry::Validatable
+
+            validations do
+              validates :config, array_of_strings_or_regexps: true
+            end
+
+            def value
+              { refs: @config }
+            end
+          end
+
+          class ComplexPolicy < Entry::Node
+            include Entry::Validatable
+            include Entry::Attributable
+
+            attributes :refs, :kubernetes
+
+            validations do
+              validates :config, presence: true
+              validates :config, allowed_keys: %i[refs kubernetes]
+
+              with_options allow_nil: true do
+                validates :refs, array_of_strings_or_regexps: true
+                validates :kubernetes, allowed_values: %w[active]
+              end
+            end
+          end
+
+          class UnknownStrategy < Entry::Node
+            def errors
+              ["#{location} has to be either an array of conditions or a hash"]
+            end
+          end
+
+          def self.default
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,34 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a configuration of Docker service.
+        #
+        class Service < Image
+          include Validatable
+
+          ALLOWED_KEYS = %i[name entrypoint command alias].freeze
+
+          validations do
+            validates :config, hash_or_string: true
+            validates :config, allowed_keys: ALLOWED_KEYS
+
+            validates :name, type: String, presence: true
+            validates :entrypoint, array_of_strings: true, allow_nil: true
+            validates :command, array_of_strings: true, allow_nil: true
+            validates :alias, type: String, allow_nil: true
+          end
+
+          def alias
+            value[:alias]
+          end
+
+          def command
+            value[:command]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        ##
+        # Entry that represents a configuration of Docker services.
+        #
+        class Services < Node
+          include Validatable
+
+          validations do
+            validates :config, type: Array
+          end
+
+          def compose!(deps = nil)
+            super do
+              @entries = []
+              @config.each do |config|
+                @entries << Entry::Factory.new(Entry::Service)
+                  .value(config || {})
+                  .create!
+              end
+
+              @entries.each do |entry|
+                entry.compose!(deps)
+              end
+            end
+          end
+
+          def value
+            @entries.map(&:value)
+          end
+
+          def descendants
+            @entries
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Gitlab
+  module Ci
+    class Config
+      module Entry
+        class Simplifiable < SimpleDelegator
+          EntryStrategy = Struct.new(:name, :condition)
+
+          def initialize(config, **metadata)
+            unless self.class.const_defined?(:UnknownStrategy)
+              raise ArgumentError, 'UndefinedStrategy not available!'
+            end
+
+            strategy = self.class.strategies.find do |variant|
+              variant.condition.call(config)
+            end
+
+            entry = self.class.entry_class(strategy)
+
+            super(entry.new(config, metadata))
+          end
+
+          def self.strategy(name, **opts)
+            EntryStrategy.new(name, opts.fetch(:if)).tap do |strategy|
+              strategies.append(strategy)
+            end
+          end
+
+          def self.strategies
+            @strategies ||= []
+          end
+
+          def self.entry_class(strategy)
+            if strategy.present?
+              self.const_get(strategy.name)
+            else
+              self::UnknownStrategy
+            end
+          end
+        end
+      end
+    end
+  end
+end