Improve naming convention in ci configuration modulefix/improve-naming-convention-in-ci-config

28 files changed, 101 insertions, 103 deletions

diff --git a/lib/gitlab/ci/config/node/artifacts.rb b/lib/gitlab/ci/config/entry/artifacts.rb
index 844bd2fe998..b756b0d4555 100644
--- a/lib/gitlab/ci/config/node/artifacts.rb
+++ b/lib/gitlab/ci/config/entry/artifacts.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a configuration of job artifacts.
         #
-        class Artifacts < Entry
+        class Artifacts < Node
           include Validatable
           include Attributable
 
diff --git a/lib/gitlab/ci/config/node/attributable.rb b/lib/gitlab/ci/config/entry/attributable.rb
index 221b666f9f6..1c8b55ee4c4 100644
--- a/lib/gitlab/ci/config/node/attributable.rb
+++ b/lib/gitlab/ci/config/entry/attributable.rb
@@ -1,7 +1,7 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         module Attributable
           extend ActiveSupport::Concern
 
diff --git a/lib/gitlab/ci/config/node/boolean.rb b/lib/gitlab/ci/config/entry/boolean.rb
index 84b03ee7832..f3357f85b99 100644
--- a/lib/gitlab/ci/config/node/boolean.rb
+++ b/lib/gitlab/ci/config/entry/boolean.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a boolean value.
         #
-        class Boolean < Entry
+        class Boolean < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/cache.rb b/lib/gitlab/ci/config/entry/cache.rb
index b4bda2841ac..544e0953b17 100644
--- a/lib/gitlab/ci/config/node/cache.rb
+++ b/lib/gitlab/ci/config/entry/cache.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a cache configuration
         #
-        class Cache < Entry
+        class Cache < Node
           include Configurable
 
           ALLOWED_KEYS = %i[key untracked paths]
@@ -14,13 +14,13 @@ module Gitlab
             validates :config, allowed_keys: ALLOWED_KEYS
           end
 
-          node :key, Node::Key,
+          node :key, Entry::Key,
             description: 'Cache key used to define a cache affinity.'
 
-          node :untracked, Node::Boolean,
+          node :untracked, Entry::Boolean,
             description: 'Cache all untracked files.'
 
-          node :paths, Node::Paths,
+          node :paths, Entry::Paths,
             description: 'Specify which paths should be cached across builds.'
         end
       end
diff --git a/lib/gitlab/ci/config/node/commands.rb b/lib/gitlab/ci/config/entry/commands.rb
index d7657ae314b..65d19db249c 100644
--- a/lib/gitlab/ci/config/node/commands.rb
+++ b/lib/gitlab/ci/config/entry/commands.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a job script.
         #
-        class Commands < Entry
+        class Commands < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/configurable.rb b/lib/gitlab/ci/config/entry/configurable.rb
index 6b7ab2fdaf2..b6c7b05e369 100644
--- a/lib/gitlab/ci/config/node/configurable.rb
+++ b/lib/gitlab/ci/config/entry/configurable.rb
@@ -1,7 +1,7 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # This mixin is responsible for adding DSL, which purpose is to
         # simplifly process of adding child nodes.
@@ -49,7 +49,7 @@ module Gitlab
             private # rubocop:disable Lint/UselessAccessModifier
 
             def node(key, node, metadata)
-              factory = Node::Factory.new(node)
+              factory = Entry::Factory.new(node)
                 .with(description: metadata[:description])
 
               (@nodes ||= {}).merge!(key.to_sym => factory)
diff --git a/lib/gitlab/ci/config/node/environment.rb b/lib/gitlab/ci/config/entry/environment.rb
index 9a95ef43628..b7b4b91eb51 100644
--- a/lib/gitlab/ci/config/node/environment.rb
+++ b/lib/gitlab/ci/config/entry/environment.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents an environment.
         #
-        class Environment < Entry
+        class Environment < Node
           include Validatable
 
           ALLOWED_KEYS = %i[name url action on_stop]
diff --git a/lib/gitlab/ci/config/node/factory.rb b/lib/gitlab/ci/config/entry/factory.rb
index 5387f29ad59..9f5e393d191 100644
--- a/lib/gitlab/ci/config/node/factory.rb
+++ b/lib/gitlab/ci/config/entry/factory.rb
@@ -1,15 +1,15 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
-        # Factory class responsible for fabricating node entry objects.
+        # Factory class responsible for fabricating entry objects.
         #
         class Factory
           class InvalidFactory < StandardError; end
 
-          def initialize(node)
-            @node = node
+          def initialize(entry)
+            @entry = entry
             @metadata = {}
             @attributes = {}
           end
@@ -37,11 +37,11 @@ module Gitlab
             # See issue #18775.
             #
             if @value.nil?
-              Node::Unspecified.new(
+              Entry::Unspecified.new(
                 fabricate_unspecified
               )
             else
-              fabricate(@node, @value)
+              fabricate(@entry, @value)
             end
           end
 
@@ -49,21 +49,21 @@ module Gitlab
 
           def fabricate_unspecified
             ##
-            # If node has a default value we fabricate concrete node
+            # If entry has a default value we fabricate concrete node
             # with default value.
             #
-            if @node.default.nil?
-              fabricate(Node::Undefined)
+            if @entry.default.nil?
+              fabricate(Entry::Undefined)
             else
-              fabricate(@node, @node.default)
+              fabricate(@entry, @entry.default)
             end
           end
 
-          def fabricate(node, value = nil)
-            node.new(value, @metadata).tap do |entry|
-              entry.key = @attributes[:key]
-              entry.parent = @attributes[:parent]
-              entry.description = @attributes[:description]
+          def fabricate(entry, value = nil)
+            entry.new(value, @metadata).tap do |node|
+              node.key = @attributes[:key]
+              node.parent = @attributes[:parent]
+              node.description = @attributes[:description]
             end
           end
         end
diff --git a/lib/gitlab/ci/config/node/global.rb b/lib/gitlab/ci/config/entry/global.rb
index 2a2943c9288..cdf314a4b37 100644
--- a/lib/gitlab/ci/config/node/global.rb
+++ b/lib/gitlab/ci/config/entry/global.rb
@@ -1,36 +1,36 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
-        # This class represents a global entry - root node for entire
+        # This class represents a global entry - root Entry for entire
         # GitLab CI Configuration file.
         #
-        class Global < Entry
+        class Global < Node
           include Configurable
 
-          node :before_script, Node::Script,
+          node :before_script, Entry::Script,
             description: 'Script that will be executed before each job.'
 
-          node :image, Node::Image,
+          node :image, Entry::Image,
             description: 'Docker image that will be used to execute jobs.'
 
-          node :services, Node::Services,
+          node :services, Entry::Services,
             description: 'Docker images that will be linked to the container.'
 
-          node :after_script, Node::Script,
+          node :after_script, Entry::Script,
             description: 'Script that will be executed after each job.'
 
-          node :variables, Node::Variables,
+          node :variables, Entry::Variables,
             description: 'Environment variables that will be used.'
 
-          node :stages, Node::Stages,
+          node :stages, Entry::Stages,
             description: 'Configuration of stages for this pipeline.'
 
-          node :types, Node::Stages,
+          node :types, Entry::Stages,
             description: 'Deprecated: stages for this pipeline.'
 
-          node :cache, Node::Cache,
+          node :cache, Entry::Cache,
             description: 'Configure caching between build jobs.'
 
           helpers :before_script, :image, :services, :after_script,
@@ -46,7 +46,7 @@ module Gitlab
           private
 
           def compose_jobs!
-            factory = Node::Factory.new(Node::Jobs)
+            factory = Entry::Factory.new(Entry::Jobs)
               .value(@config.except(*self.class.nodes.keys))
               .with(key: :jobs, parent: self,
                     description: 'Jobs definition for this pipeline')
diff --git a/lib/gitlab/ci/config/node/hidden.rb b/lib/gitlab/ci/config/entry/hidden.rb
index fe4ee8a7fc6..6fc3aa385bc 100644
--- a/lib/gitlab/ci/config/node/hidden.rb
+++ b/lib/gitlab/ci/config/entry/hidden.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
-        # Entry that represents a hidden CI/CD job.
+        # Entry that represents a hidden CI/CD key.
         #
-        class Hidden < Entry
+        class Hidden < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/image.rb b/lib/gitlab/ci/config/entry/image.rb
index 5d3c7c5eab0..b5050257688 100644
--- a/lib/gitlab/ci/config/node/image.rb
+++ b/lib/gitlab/ci/config/entry/image.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a Docker image.
         #
-        class Image < Entry
+        class Image < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/job.rb b/lib/gitlab/ci/config/entry/job.rb
index 603334d6793..b4e69a04706 100644
--- a/lib/gitlab/ci/config/node/job.rb
+++ b/lib/gitlab/ci/config/entry/job.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a concrete CI/CD job.
         #
-        class Job < Entry
+        class Job < Node
           include Configurable
           include Attributable
 
@@ -34,43 +34,43 @@ module Gitlab
             end
           end
 
-          node :before_script, Node::Script,
+          node :before_script, Entry::Script,
             description: 'Global before script overridden in this job.'
 
-          node :script, Node::Commands,
+          node :script, Entry::Commands,
             description: 'Commands that will be executed in this job.'
 
-          node :stage, Node::Stage,
+          node :stage, Entry::Stage,
             description: 'Pipeline stage this job will be executed into.'
 
-          node :type, Node::Stage,
+          node :type, Entry::Stage,
             description: 'Deprecated: stage this job will be executed into.'
 
-          node :after_script, Node::Script,
+          node :after_script, Entry::Script,
             description: 'Commands that will be executed when finishing job.'
 
-          node :cache, Node::Cache,
+          node :cache, Entry::Cache,
             description: 'Cache definition for this job.'
 
-          node :image, Node::Image,
+          node :image, Entry::Image,
             description: 'Image that will be used to execute this job.'
 
-          node :services, Node::Services,
+          node :services, Entry::Services,
             description: 'Services that will be used to execute this job.'
 
-          node :only, Node::Trigger,
+          node :only, Entry::Trigger,
             description: 'Refs policy this job will be executed for.'
 
-          node :except, Node::Trigger,
+          node :except, Entry::Trigger,
             description: 'Refs policy this job will be executed for.'
 
-          node :variables, Node::Variables,
+          node :variables, Entry::Variables,
             description: 'Environment variables available for this job.'
 
-          node :artifacts, Node::Artifacts,
+          node :artifacts, Entry::Artifacts,
             description: 'Artifacts configuration for this job.'
 
-          node :environment, Node::Environment,
+          node :environment, Entry::Environment,
                description: 'Environment configuration for this job.'
 
           helpers :before_script, :script, :stage, :type, :after_script,
diff --git a/lib/gitlab/ci/config/node/jobs.rb b/lib/gitlab/ci/config/entry/jobs.rb
index d10e80d1a7d..5671a09480b 100644
--- a/lib/gitlab/ci/config/node/jobs.rb
+++ b/lib/gitlab/ci/config/entry/jobs.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a set of jobs.
         #
-        class Jobs < Entry
+        class Jobs < Node
           include Validatable
 
           validations do
@@ -29,9 +29,9 @@ module Gitlab
           def compose!(deps = nil)
             super do
               @config.each do |name, config|
-                node = hidden?(name) ? Node::Hidden : Node::Job
+                node = hidden?(name) ? Entry::Hidden : Entry::Job
 
-                factory = Node::Factory.new(node)
+                factory = Entry::Factory.new(node)
                   .value(config || {})
                   .metadata(name: name)
                   .with(key: name, parent: self,
diff --git a/lib/gitlab/ci/config/node/key.rb b/lib/gitlab/ci/config/entry/key.rb
index f8b461ca098..0e4c9fe6edc 100644
--- a/lib/gitlab/ci/config/node/key.rb
+++ b/lib/gitlab/ci/config/entry/key.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a key.
         #
-        class Key < Entry
+        class Key < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/legacy_validation_helpers.rb b/lib/gitlab/ci/config/entry/legacy_validation_helpers.rb
index 0c291efe6a5..f01975aab5c 100644
--- a/lib/gitlab/ci/config/node/legacy_validation_helpers.rb
+++ b/lib/gitlab/ci/config/entry/legacy_validation_helpers.rb
@@ -1,7 +1,7 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         module LegacyValidationHelpers
           private
 
diff --git a/lib/gitlab/ci/config/node/entry.rb b/lib/gitlab/ci/config/entry/node.rb
index 8717eabf81e..5eef2868cd6 100644
--- a/lib/gitlab/ci/config/node/entry.rb
+++ b/lib/gitlab/ci/config/entry/node.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Base abstract class for each configuration entry node.
         #
-        class Entry
+        class Node
           class InvalidError < StandardError; end
 
           attr_reader :config, :metadata
@@ -21,7 +21,7 @@ module Gitlab
           end
 
           def [](key)
-            @entries[key] || Node::Undefined.new
+            @entries[key] || Entry::Undefined.new
           end
 
           def compose!(deps = nil)
diff --git a/lib/gitlab/ci/config/node/paths.rb b/lib/gitlab/ci/config/entry/paths.rb
index 3c6d3a52966..68dad161149 100644
--- a/lib/gitlab/ci/config/node/paths.rb
+++ b/lib/gitlab/ci/config/entry/paths.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents an array of paths.
         #
-        class Paths < Entry
+        class Paths < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/script.rb b/lib/gitlab/ci/config/entry/script.rb
index 39328f0fade..29ecd9995ca 100644
--- a/lib/gitlab/ci/config/node/script.rb
+++ b/lib/gitlab/ci/config/entry/script.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a script.
         #
-        class Script < Entry
+        class Script < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/services.rb b/lib/gitlab/ci/config/entry/services.rb
index 481e2b66adc..84f8ab780f5 100644
--- a/lib/gitlab/ci/config/node/services.rb
+++ b/lib/gitlab/ci/config/entry/services.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a configuration of Docker services.
         #
-        class Services < Entry
+        class Services < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/stage.rb b/lib/gitlab/ci/config/entry/stage.rb
index cbc97641f5a..b7afaba1de8 100644
--- a/lib/gitlab/ci/config/node/stage.rb
+++ b/lib/gitlab/ci/config/entry/stage.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a stage for a job.
         #
-        class Stage < Entry
+        class Stage < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/stages.rb b/lib/gitlab/ci/config/entry/stages.rb
index b1fe45357ff..ec187bd3732 100644
--- a/lib/gitlab/ci/config/node/stages.rb
+++ b/lib/gitlab/ci/config/entry/stages.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a configuration for pipeline stages.
         #
-        class Stages < Entry
+        class Stages < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/trigger.rb b/lib/gitlab/ci/config/entry/trigger.rb
index d8b31975088..28b0a9ffe01 100644
--- a/lib/gitlab/ci/config/node/trigger.rb
+++ b/lib/gitlab/ci/config/entry/trigger.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
         # Entry that represents a trigger policy for the job.
         #
-        class Trigger < Entry
+        class Trigger < Node
           include Validatable
 
           validations do
diff --git a/lib/gitlab/ci/config/node/undefined.rb b/lib/gitlab/ci/config/entry/undefined.rb
index 33e78023539..b33b8238230 100644
--- a/lib/gitlab/ci/config/node/undefined.rb
+++ b/lib/gitlab/ci/config/entry/undefined.rb
@@ -1,13 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
-        # This class represents an undefined node.
+        # This class represents an undefined entry.
         #
-        # Implements the Null Object pattern.
-        #
-        class Undefined < Entry
+        class Undefined < Node
           def initialize(*)
             super(nil)
           end
diff --git a/lib/gitlab/ci/config/node/unspecified.rb b/lib/gitlab/ci/config/entry/unspecified.rb
index a7d1f6131b8..fbb2551e870 100644
--- a/lib/gitlab/ci/config/node/unspecified.rb
+++ b/lib/gitlab/ci/config/entry/unspecified.rb
@@ -1,9 +1,9 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         ##
-        # This class represents an unspecified entry node.
+        # This class represents an unspecified entry.
         #
         # It decorates original entry adding method that indicates it is
         # unspecified.
diff --git a/lib/gitlab/ci/config/node/validatable.rb b/lib/gitlab/ci/config/entry/validatable.rb
index 085e6e988d1..f7f1b111571 100644
--- a/lib/gitlab/ci/config/node/validatable.rb
+++ b/lib/gitlab/ci/config/entry/validatable.rb
@@ -1,13 +1,13 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         module Validatable
           extend ActiveSupport::Concern
 
           class_methods do
             def validator
-              @validator ||= Class.new(Node::Validator).tap do |validator|
+              @validator ||= Class.new(Entry::Validator).tap do |validator|
                 if defined?(@validations)
                   @validations.each { |rules| validator.class_eval(&rules) }
                 end
diff --git a/lib/gitlab/ci/config/node/validator.rb b/lib/gitlab/ci/config/entry/validator.rb
index 43c7e102b50..55343005fe3 100644
--- a/lib/gitlab/ci/config/node/validator.rb
+++ b/lib/gitlab/ci/config/entry/validator.rb
@@ -1,14 +1,14 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         class Validator < SimpleDelegator
           include ActiveModel::Validations
-          include Node::Validators
+          include Entry::Validators
 
-          def initialize(node)
-            super(node)
-            @node = node
+          def initialize(entry)
+            super(entry)
+            @entry = entry
           end
 
           def messages
@@ -30,7 +30,7 @@ module Gitlab
 
           def key_name
             if key.blank?
-              @node.class.name.demodulize.underscore.humanize
+              @entry.class.name.demodulize.underscore.humanize
             else
               key
             end
diff --git a/lib/gitlab/ci/config/node/validators.rb b/lib/gitlab/ci/config/entry/validators.rb
index e20908ad3cb..8632dd0e233 100644
--- a/lib/gitlab/ci/config/node/validators.rb
+++ b/lib/gitlab/ci/config/entry/validators.rb
@@ -1,7 +1,7 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+      module Entry
         module Validators
           class AllowedKeysValidator < ActiveModel::EachValidator
             def validate_each(record, attribute, value)
diff --git a/lib/gitlab/ci/config/node/variables.rb b/lib/gitlab/ci/config/entry/variables.rb
index 5f813f81f55..f615874fa68 100644
--- a/lib/gitlab/ci/config/node/variables.rb
+++ b/lib/gitlab/ci/config/entry/variables.rb
@@ -1,11 +1,11 @@
 module Gitlab
   module Ci
     class Config
-      module Node
+     module Entry
         ##
         # Entry that represents environment variables.
         #
-        class Variables < Entry
+        class Variables < Node
           include Validatable
 
           validations do