Add latest changes from gitlab-org/gitlab@master

3 files changed, 317 insertions, 5 deletions

diff --git a/spec/lib/gitlab/static_site_editor/config/file_config/entry/global_spec.rb b/spec/lib/gitlab/static_site_editor/config/file_config/entry/global_spec.rb
new file mode 100644
index 00000000000..57edcd8a07b
--- /dev/null
+++ b/spec/lib/gitlab/static_site_editor/config/file_config/entry/global_spec.rb
@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::StaticSiteEditor::Config::FileConfig::Entry::Global do
+  let(:global) { described_class.new(hash) }
+  let(:default_static_site_generator_value) { 'middleman' }
+
+  shared_examples_for 'valid default configuration' do
+    describe '#compose!' do
+      before do
+        global.compose!
+      end
+
+      it 'creates nodes hash' do
+        expect(global.descendants).to be_an Array
+      end
+
+      it 'creates node object for each entry' do
+        expect(global.descendants.count).to eq 1
+      end
+
+      it 'creates node object using valid class' do
+        expect(global.descendants.first)
+          .to be_an_instance_of expected_node_object_class
+      end
+
+      it 'sets correct description for nodes' do
+        expect(global.descendants.first.description)
+          .to eq 'Configuration of the Static Site Editor static site generator.'
+      end
+
+      describe '#leaf?' do
+        it 'is not leaf' do
+          expect(global).not_to be_leaf
+        end
+      end
+    end
+
+    context 'when not composed' do
+      describe '#static_site_generator_value' do
+        it 'returns nil' do
+          expect(global.static_site_generator_value).to be nil
+        end
+      end
+
+      describe '#leaf?' do
+        it 'is leaf' do
+          expect(global).to be_leaf
+        end
+      end
+    end
+
+    context 'when composed' do
+      before do
+        global.compose!
+      end
+
+      describe '#errors' do
+        it 'has no errors' do
+          expect(global.errors).to be_empty
+        end
+      end
+
+      describe '#static_site_generator_value' do
+        it 'returns correct values' do
+          expect(global.static_site_generator_value).to eq(default_static_site_generator_value)
+        end
+      end
+    end
+  end
+
+  describe '.nodes' do
+    it 'returns a hash' do
+      expect(described_class.nodes).to be_a(Hash)
+    end
+
+    context 'when filtering all the entry/node names' do
+      it 'contains the expected node names' do
+        expect(described_class.nodes.keys)
+          .to match_array(%i[static_site_generator])
+      end
+    end
+  end
+
+  context 'when configuration is valid' do
+    context 'when some entries defined' do
+      let(:expected_node_object_class) { Gitlab::StaticSiteEditor::Config::FileConfig::Entry::StaticSiteGenerator }
+      let(:hash) do
+        { static_site_generator: default_static_site_generator_value }
+      end
+
+      it_behaves_like 'valid default configuration'
+    end
+  end
+
+  context 'when value is an empty hash' do
+    let(:expected_node_object_class) { Gitlab::Config::Entry::Unspecified }
+    let(:hash) { {} }
+
+    it_behaves_like 'valid default configuration'
+  end
+
+  context 'when configuration is not valid' do
+    before do
+      global.compose!
+    end
+
+    context 'when static_site_generator is invalid' do
+      let(:hash) do
+        { static_site_generator: { not_a_string: true } }
+      end
+
+      describe '#errors' do
+        it 'reports errors' do
+          expect(global.errors)
+            .to include 'static_site_generator config should be a string'
+        end
+      end
+    end
+
+    context 'when there is an invalid key' do
+      let(:hash) do
+        { invalid_key: true }
+      end
+
+      describe '#errors' do
+        it 'reports errors' do
+          expect(global.errors)
+            .to include 'global config contains unknown keys: invalid_key'
+        end
+      end
+    end
+  end
+
+  context 'when value is not a hash' do
+    let(:hash) { [] }
+
+    describe '#valid?' do
+      it 'is not valid' do
+        expect(global).not_to be_valid
+      end
+    end
+
+    describe '#errors' do
+      it 'returns error about invalid type' do
+        expect(global.errors.first).to match /should be a hash/
+      end
+    end
+  end
+
+  describe '#specified?' do
+    it 'is concrete entry that is defined' do
+      expect(global.specified?).to be true
+    end
+  end
+
+  describe '#[]' do
+    before do
+      global.compose!
+    end
+
+    let(:hash) do
+      { static_site_generator: default_static_site_generator_value }
+    end
+
+    context 'when entry exists' do
+      it 'returns correct entry' do
+        expect(global[:static_site_generator])
+          .to be_an_instance_of Gitlab::StaticSiteEditor::Config::FileConfig::Entry::StaticSiteGenerator
+        expect(global[:static_site_generator].value).to eq default_static_site_generator_value
+      end
+    end
+
+    context 'when entry does not exist' do
+      it 'always return unspecified node' do
+        expect(global[:some][:unknown][:node])
+          .not_to be_specified
+      end
+    end
+  end
+end
diff --git a/spec/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator_spec.rb b/spec/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator_spec.rb
new file mode 100644
index 00000000000..a9c730218cf
--- /dev/null
+++ b/spec/lib/gitlab/static_site_editor/config/file_config/entry/static_site_generator_spec.rb
@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::StaticSiteEditor::Config::FileConfig::Entry::StaticSiteGenerator do
+  let(:static_site_generator) { described_class.new(config) }
+
+  describe 'validations' do
+    context 'when value is valid' do
+      let(:config) { 'middleman' }
+
+      describe '#value' do
+        it 'returns a static_site_generator key' do
+          expect(static_site_generator.value).to eq config
+        end
+      end
+
+      describe '#valid?' do
+        it 'is valid' do
+          expect(static_site_generator).to be_valid
+        end
+      end
+    end
+
+    context 'when value is invalid' do
+      let(:config) { 'not-a-valid-generator' }
+
+      describe '#valid?' do
+        it 'is not valid' do
+          expect(static_site_generator).not_to be_valid
+        end
+      end
+    end
+
+    context 'when value has a wrong type' do
+      let(:config) { { not_a_string: true } }
+
+      it 'reports errors about wrong type' do
+        expect(static_site_generator.errors)
+          .to include 'static site generator config should be a string'
+      end
+    end
+  end
+
+  describe '.default' do
+    it 'returns default static_site_generator' do
+      expect(described_class.default).to eq 'middleman'
+    end
+  end
+end
diff --git a/spec/lib/gitlab/static_site_editor/config/file_config_spec.rb b/spec/lib/gitlab/static_site_editor/config/file_config_spec.rb
index 594425c2dab..198ba611cf6 100644
--- a/spec/lib/gitlab/static_site_editor/config/file_config_spec.rb
+++ b/spec/lib/gitlab/static_site_editor/config/file_config_spec.rb
@@ -3,13 +3,93 @@
 require 'spec_helper'
 
 RSpec.describe Gitlab::StaticSiteEditor::Config::FileConfig do
-  subject(:config) { described_class.new }
+  let(:config) do
+    described_class.new(yml)
+  end
+
+  context 'when config is valid' do
+    context 'when config has valid values' do
+      let(:yml) do
+        <<-EOS
+        static_site_generator: middleman
+        EOS
+      end
+
+      describe '#to_hash_with_defaults' do
+        it 'returns hash created from string' do
+          hash = {
+            static_site_generator: 'middleman'
+          }
+
+          expect(config.to_hash_with_defaults).to eq hash
+        end
+      end
+
+      describe '#valid?' do
+        it 'is valid' do
+          expect(config).to be_valid
+        end
+
+        it 'has no errors' do
+          expect(config.errors).to be_empty
+        end
+      end
+    end
+  end
+
+  context 'when a config entry has an empty value' do
+    let(:yml) { 'static_site_generator: ' }
+
+    describe '#to_hash_with_defaults' do
+      it 'returns default values' do
+        hash = {
+          static_site_generator: 'middleman'
+        }
+
+        expect(config.to_hash_with_defaults).to eq hash
+      end
+    end
+
+    describe '#valid?' do
+      it 'is valid' do
+        expect(config).to be_valid
+      end
+
+      it 'has no errors' do
+        expect(config.errors).to be_empty
+      end
+    end
+  end
+
+  context 'when config is invalid' do
+    context 'when yml is incorrect' do
+      let(:yml) { '// invalid' }
+
+      describe '.new' do
+        it 'raises error' do
+          expect { config }.to raise_error(described_class::ConfigError, /Invalid configuration format/)
+        end
+      end
+    end
+
+    context 'when config value exists but is not a valid value' do
+      let(:yml) { 'static_site_generator: "unsupported-generator"' }
+
+      describe '#valid?' do
+        it 'is not valid' do
+          expect(config).not_to be_valid
+        end
 
-  describe '#data' do
-    subject { config.data }
+        it 'has errors' do
+          expect(config.errors).not_to be_empty
+        end
+      end
 
-    it 'returns hardcoded data for now' do
-      is_expected.to match(static_site_generator: 'middleman')
+      describe '#errors' do
+        it 'returns an array of strings' do
+          expect(config.errors).to all(be_an_instance_of(String))
+        end
+      end
     end
   end
 end