Add latest changes from gitlab-org/gitlab@13-5-stable-eev13.5.0-rc42

7 files changed, 201 insertions, 9 deletions

diff --git a/lib/gitlab/static_site_editor/config/file_config.rb b/lib/gitlab/static_site_editor/config/file_config.rb
index f647c85e1c8..315c603c1dd 100644
--- a/lib/gitlab/static_site_editor/config/file_config.rb
+++ b/lib/gitlab/static_site_editor/config/file_config.rb
@@ -3,11 +3,38 @@
 module Gitlab
   module StaticSiteEditor
     module Config
+      #
+      # Base GitLab Static Site Editor Configuration facade
+      #
       class FileConfig
-        def data
-          {
-            static_site_generator: 'middleman'
-          }
+        ConfigError = Class.new(StandardError)
+
+        def initialize(yaml)
+          content_hash = content_hash(yaml)
+          @global = Entry::Global.new(content_hash)
+          @global.compose!
+        rescue Gitlab::Config::Loader::FormatError => e
+          raise FileConfig::ConfigError, e.message
+        end
+
+        def valid?
+          @global.valid?
+        end
+
+        def errors
+          @global.errors
+        end
+
+        def to_hash_with_defaults
+          # NOTE: The current approach of simply mapping all the descendents' keys and values ('config')
+          #       into a flat hash may need to be enhanced as we add more complex, non-scalar entries.
+          @global.descendants.map { |descendant| [descendant.key, descendant.config] }.to_h
+        end
+
+        private
+
+        def content_hash(yaml)
+          Gitlab::Config::Loader::Yaml.new(yaml).load!
         end
       end
     end
diff --git a/lib/gitlab/static_site_editor/config/file_config/entry/global.rb b/lib/gitlab/static_site_editor/config/file_config/entry/global.rb
new file mode 100644
index 00000000000..c295ccf1d11
--- /dev/null
+++ b/lib/gitlab/static_site_editor/config/file_config/entry/global.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module StaticSiteEditor
+    module Config
+      class FileConfig
+        module Entry
+          ##
+          # This class represents a global entry - root Entry for entire
+          # GitLab StaticSiteEditor Configuration file.
+          #
+          class Global < ::Gitlab::Config::Entry::Node
+            include ::Gitlab::Config::Entry::Configurable
+            include ::Gitlab::Config::Entry::Attributable
+
+            ALLOWED_KEYS = %i[
+              image_upload_path
+              mounts
+              static_site_generator
+            ].freeze
+
+            attributes ALLOWED_KEYS
+
+            validations do
+              validates :config, allowed_keys: ALLOWED_KEYS
+            end
+
+            entry :image_upload_path, Entry::ImageUploadPath,
+                  description: 'Configuration of the Static Site Editor image upload path.'
+            entry :mounts, Entry::Mounts,
+                  description: 'Configuration of the Static Site Editor mounts.'
+            entry :static_site_generator, Entry::StaticSiteGenerator,
+                  description: 'Configuration of the Static Site Editor static site generator.'
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/static_site_editor/config/file_config/entry/image_upload_path.rb b/lib/gitlab/static_site_editor/config/file_config/entry/image_upload_path.rb
new file mode 100644
index 00000000000..6a2b9e10d33
--- /dev/null
+++ b/lib/gitlab/static_site_editor/config/file_config/entry/image_upload_path.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module StaticSiteEditor
+    module Config
+      class FileConfig
+        module Entry
+          ##
+          # Entry that represents the path to which images will be uploaded
+          #
+          class ImageUploadPath < ::Gitlab::Config::Entry::Node
+            include ::Gitlab::Config::Entry::Validatable
+
+            validations do
+              validates :config, type: String
+            end
+
+            def self.default
+              'source/images'
+            end
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/static_site_editor/config/file_config/entry/mount.rb b/lib/gitlab/static_site_editor/config/file_config/entry/mount.rb
new file mode 100644
index 00000000000..b10956e17a5
--- /dev/null
+++ b/lib/gitlab/static_site_editor/config/file_config/entry/mount.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module StaticSiteEditor
+    module Config
+      class FileConfig
+        module Entry
+          ##
+          # Entry that represents the mappings of mounted source directories to target paths
+          #
+          class Mount < ::Gitlab::Config::Entry::Node
+            include ::Gitlab::Config::Entry::Validatable
+            include ::Gitlab::Config::Entry::Attributable
+
+            ALLOWED_KEYS = %i[source target].freeze
+
+            attributes ALLOWED_KEYS
+
+            validations do
+              validates :config, allowed_keys: ALLOWED_KEYS
+
+              validates :source, type: String, presence: true
+              validates :target, type: String, presence: true, allow_blank: true
+            end
+
+            def self.default
+              # NOTE: This is the default for middleman projects.  Ideally, this would be determined
+              #       based on the defaults for whatever `static_site_generator` is configured.
+              {
+                source: 'source',
+                target: ''
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/static_site_editor/config/file_config/entry/mounts.rb b/lib/gitlab/static_site_editor/config/file_config/entry/mounts.rb
new file mode 100644
index 00000000000..10bd377e419
--- /dev/null
+++ b/lib/gitlab/static_site_editor/config/file_config/entry/mounts.rb
@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module StaticSiteEditor
+    module Config
+      class FileConfig
+        module Entry
+          ##
+          # Entry that represents the mappings of mounted source directories to target paths
+          #
+          class Mounts < ::Gitlab::Config::Entry::Node
+            include ::Gitlab::Config::Entry::Configurable
+            include ::Gitlab::Config::Entry::Validatable
+
+            entry :mount, Entry::Mount, description: 'Configuration of a Static Site Editor mount.'
+
+            validations do
+              validates :config, type: Array, presence: true
+            end
+
+            def skip_config_hash_validation?
+              true
+            end
+
+            def self.default
+              [Entry::Mount.default]
+            end
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator.rb b/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator.rb
new file mode 100644
index 00000000000..593c0951f93
--- /dev/null
+++ b/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module StaticSiteEditor
+    module Config
+      class FileConfig
+        module Entry
+          ##
+          # Entry that represents the static site generator tool/framework.
+          #
+          class StaticSiteGenerator < ::Gitlab::Config::Entry::Node
+            include ::Gitlab::Config::Entry::Validatable
+
+            validations do
+              validates :config, type: String, inclusion: { in: %w[middleman], message: "should be 'middleman'" }
+            end
+
+            def self.default
+              'middleman'
+            end
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/static_site_editor/config/generated_config.rb b/lib/gitlab/static_site_editor/config/generated_config.rb
index f3dce74a32f..ff24ec69ab0 100644
--- a/lib/gitlab/static_site_editor/config/generated_config.rb
+++ b/lib/gitlab/static_site_editor/config/generated_config.rb
@@ -4,8 +4,6 @@ module Gitlab
   module StaticSiteEditor
     module Config
       class GeneratedConfig
-        SUPPORTED_EXTENSIONS = %w[.md].freeze
-
         def initialize(repository, ref, path, return_url)
           @repository = repository
           @ref = ref
@@ -23,7 +21,7 @@ module Gitlab
             project: project.path,
             namespace: project.namespace.full_path,
             return_url: sanitize_url(return_url),
-            is_supported_content: supported_content?.to_s,
+            is_supported_content: supported_content?,
             base_url: Gitlab::Routing.url_helpers.project_show_sse_path(project, full_path),
             merge_requests_illustration_path: merge_requests_illustration_path
           }
@@ -35,8 +33,12 @@ module Gitlab
 
         delegate :project, to: :repository
 
+        def supported_extensions
+          %w[.md].freeze
+        end
+
         def commit_id
-          repository.commit(ref)&.id if ref
+          repository.commit(ref)&.id
         end
 
         def supported_content?
@@ -50,7 +52,7 @@ module Gitlab
         def extension_supported?
           return true if path.end_with?('.md.erb') && Feature.enabled?(:sse_erb_support, project)
 
-          SUPPORTED_EXTENSIONS.any? { |ext| path.end_with?(ext) }
+          supported_extensions.any? { |ext| path.end_with?(ext) }
         end
 
         def file_exists?