diff --git a/app/controllers/projects/web_ide_schemas_controller.rb b/app/controllers/projects/web_ide_schemas_controller.rb
new file mode 100644
index 0000000000000000000000000000000000000000..3d16a6fafd42a681c7593bdf94a23b683c4643af
--- /dev/null
+++ b/app/controllers/projects/web_ide_schemas_controller.rb
@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Projects::WebIdeSchemasController < Projects::ApplicationController
+ before_action :authenticate_user!
+
+ def show
+ return respond_422 unless branch_sha
+
+ result = ::Ide::SchemasConfigService.new(project, current_user, sha: branch_sha, filename: params[:filename]).execute
+
+ if result[:status] == :success
+ render json: result[:schema]
+ else
+ render json: result, status: :unprocessable_entity
+ end
+ end
+
+ private
+
+ def branch_sha
+ return unless params[:branch].present?
+
+ project.commit(params[:branch])&.id
+ end
+end
diff --git a/app/controllers/projects/web_ide_terminals_controller.rb b/app/controllers/projects/web_ide_terminals_controller.rb
index 08ea5c4bca841dfe0a9520a759f6bb493980ed53..76bcaa9e80c3c23503247dd6edba9bceda346590 100644
--- a/app/controllers/projects/web_ide_terminals_controller.rb
+++ b/app/controllers/projects/web_ide_terminals_controller.rb
@@ -11,7 +11,7 @@ class Projects::WebIdeTerminalsController < Projects::ApplicationController
def check_config
return respond_422 unless branch_sha
- result = ::Ci::WebIdeConfigService.new(project, current_user, sha: branch_sha).execute
+ result = ::Ide::TerminalConfigService.new(project, current_user, sha: branch_sha).execute
if result[:status] == :success
head :ok
diff --git a/app/services/ci/create_web_ide_terminal_service.rb b/app/services/ci/create_web_ide_terminal_service.rb
index 4f1bf0447d2b7227ecf3289481af63fd3d8c237c..a78281aed161d067f3635968ed52198d80f7071f 100644
--- a/app/services/ci/create_web_ide_terminal_service.rb
+++ b/app/services/ci/create_web_ide_terminal_service.rb
@@ -70,7 +70,7 @@ def terminal_build_seed
end
def load_terminal_config!
- result = ::Ci::WebIdeConfigService.new(project, current_user, sha: sha).execute
+ result = ::Ide::TerminalConfigService.new(project, current_user, sha: sha).execute
raise TerminalCreationError, result[:message] if result[:status] != :success
@terminal = result[:terminal]
diff --git a/app/services/ci/web_ide_config_service.rb b/app/services/ide/base_config_service.rb
similarity index 88%
rename from app/services/ci/web_ide_config_service.rb
rename to app/services/ide/base_config_service.rb
index ade9132f419af6ec8a5ad2f7752435ea151ff175..1f8d5c17584b56606a96561acf020dafc95972be 100644
--- a/app/services/ci/web_ide_config_service.rb
+++ b/app/services/ide/base_config_service.rb
@@ -1,9 +1,7 @@
# frozen_string_literal: true
-module Ci
- class WebIdeConfigService < ::BaseService
- include ::Gitlab::Utils::StrongMemoize
-
+module Ide
+ class BaseConfigService < ::BaseService
ValidationError = Class.new(StandardError)
WEBIDE_CONFIG_FILE = '.gitlab/.gitlab-webide.yml'.freeze
@@ -11,15 +9,21 @@ class WebIdeConfigService < ::BaseService
attr_reader :config, :config_content
def execute
- check_access!
- load_config_content!
- load_config!
+ check_access_and_load_config!
- success(terminal: config.terminal_value)
+ success
rescue ValidationError => e
error(e.message)
end
+ protected
+
+ def check_access_and_load_config!
+ check_access!
+ load_config_content!
+ load_config!
+ end
+
private
def check_access!
diff --git a/app/services/ide/schemas_config_service.rb b/app/services/ide/schemas_config_service.rb
new file mode 100644
index 0000000000000000000000000000000000000000..8d2ce97103d216f0efc4cae93e6f495e60a33888
--- /dev/null
+++ b/app/services/ide/schemas_config_service.rb
@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Ide
+ class SchemasConfigService < ::Ide::BaseConfigService
+ PREDEFINED_SCHEMAS = [{
+ uri: 'https://json.schemastore.org/gitlab-ci',
+ match: ['*.gitlab-ci.yml']
+ }].freeze
+
+ def execute
+ schema = predefined_schema_for(params[:filename]) || {}
+ success(schema: schema)
+ rescue => e
+ error(e.message)
+ end
+
+ private
+
+ def find_schema(filename, schemas)
+ match_flags = ::File::FNM_DOTMATCH | ::File::FNM_PATHNAME
+
+ schemas.each do |schema|
+ match = schema[:match].any? { |pattern| ::File.fnmatch?(pattern, filename, match_flags) }
+
+ return Gitlab::Json.parse(get_cached(schema[:uri])) if match
+ end
+
+ nil
+ end
+
+ def predefined_schema_for(filename)
+ find_schema(filename, predefined_schemas)
+ end
+
+ def predefined_schemas
+ return PREDEFINED_SCHEMAS if Feature.enabled?(:schema_linting)
+
+ []
+ end
+
+ def get_cached(url)
+ Rails.cache.fetch("services:ide:schema:#{url}", expires_in: 1.day) do
+ Gitlab::HTTP.get(url).body
+ end
+ end
+ end
+end
+
+Ide::SchemasConfigService.prepend_if_ee('::EE::Ide::SchemasConfigService')
diff --git a/app/services/ide/terminal_config_service.rb b/app/services/ide/terminal_config_service.rb
new file mode 100644
index 0000000000000000000000000000000000000000..318df3436c43b6ce1b2727bbd7f844838b2a3e85
--- /dev/null
+++ b/app/services/ide/terminal_config_service.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ide
+ class TerminalConfigService < ::Ide::BaseConfigService
+ private
+
+ def success(pass_back = {})
+ result = super(pass_back)
+ result[:terminal] = config.terminal_value
+ result
+ end
+ end
+end
diff --git a/config/routes/project.rb b/config/routes/project.rb
index 3361193581e8ee966985187972154f61752f6810..24b44646d9504cf2c04e7ddc3595f69f236cddf1 100644
--- a/config/routes/project.rb
+++ b/config/routes/project.rb
@@ -378,6 +378,11 @@
post :reset_token
end
resources :feature_flags_user_lists, param: :iid, only: [:new, :edit, :show]
+
+ get '/schema/:branch/*filename',
+ to: 'web_ide_schemas#show',
+ format: false,
+ as: :schema
end
# End of the /-/ scope.
diff --git a/ee/app/models/license.rb b/ee/app/models/license.rb
index 5c238367ea6b55c8bdb01b1274a78ddd61ba9ee6..4209f523bd72f0a79defca36edb46e6fb8a0a3ba 100644
--- a/ee/app/models/license.rb
+++ b/ee/app/models/license.rb
@@ -85,6 +85,7 @@ class License < ApplicationRecord
group_project_templates
group_repository_analytics
group_saml
+ ide_schema_config
issues_analytics
jira_issues_integration
ldap_group_sync_filter
diff --git a/ee/app/services/ee/ide/schemas_config_service.rb b/ee/app/services/ee/ide/schemas_config_service.rb
new file mode 100644
index 0000000000000000000000000000000000000000..44189b9e988ba301f720777bab333c070922bcf3
--- /dev/null
+++ b/ee/app/services/ee/ide/schemas_config_service.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module EE
+ module Ide
+ module SchemasConfigService
+ extend ::Gitlab::Utils::Override
+
+ override :execute
+ def execute
+ result = super
+ return result if result[:status] == :success && !result[:schema].empty?
+
+ check_access_and_load_config!
+ success(schema: schema_from_config_for(params[:filename]) || {})
+ rescue => e
+ error(e.message)
+ end
+
+ private
+
+ def schema_from_config_for(filename)
+ return {} unless project.feature_available?(:ide_schema_config)
+
+ find_schema(filename, config.schemas_value || [])
+ end
+ end
+ end
+end
diff --git a/ee/lib/ee/gitlab/web_ide/config/entry/global.rb b/ee/lib/ee/gitlab/web_ide/config/entry/global.rb
new file mode 100644
index 0000000000000000000000000000000000000000..4fdcd6bec06ca30dc584c390ffe1ab81ef9475be
--- /dev/null
+++ b/ee/lib/ee/gitlab/web_ide/config/entry/global.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module EE
+ module Gitlab
+ module WebIde
+ module Config
+ module Entry
+ module Global
+ extend ActiveSupport::Concern
+
+ class_methods do
+ def allowed_keys
+ %i[terminal schemas].freeze
+ end
+ end
+
+ prepended do
+ entry :schemas, ::Gitlab::WebIde::Config::Entry::Schemas,
+ description: 'Configuration of JSON/YAML schemas.'
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/lib/gitlab/web_ide/config/entry/schema.rb b/ee/lib/gitlab/web_ide/config/entry/schema.rb
new file mode 100644
index 0000000000000000000000000000000000000000..5015d04cba4f9916adaf586956b67b1e78c38e1a
--- /dev/null
+++ b/ee/lib/gitlab/web_ide/config/entry/schema.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gitlab
+ module WebIde
+ class Config
+ module Entry
+ ##
+ # Entry that represents a JSON/YAML schema.
+ #
+ class Schema < ::Gitlab::Config::Entry::Node
+ include ::Gitlab::Config::Entry::Configurable
+ include ::Gitlab::Config::Entry::Attributable
+
+ ALLOWED_KEYS = %i[uri match].freeze
+
+ validations do
+ validates :config, allowed_keys: ALLOWED_KEYS
+ end
+
+ entry :uri, Entry::Schema::Uri,
+ description: 'The URI of the schema.'
+
+ entry :match, Entry::Schema::Match,
+ description: 'A list of glob expressions to match against the target file.'
+
+ def value
+ to_hash.compact
+ end
+
+ private
+
+ def to_hash
+ { uri: uri_value,
+ match: match_value || [] }
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/lib/gitlab/web_ide/config/entry/schema/match.rb b/ee/lib/gitlab/web_ide/config/entry/schema/match.rb
new file mode 100644
index 0000000000000000000000000000000000000000..90d1818513f50e6da6fb23b11c1905b7877fd3bf
--- /dev/null
+++ b/ee/lib/gitlab/web_ide/config/entry/schema/match.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gitlab
+ module WebIde
+ class Config
+ module Entry
+ class Schema
+ ##
+ # Entry that represents a list of glob expressions to match against the target file.
+ #
+ class Match < ::Gitlab::Config::Entry::Node
+ include ::Gitlab::Config::Entry::Validatable
+
+ validations do
+ validates :config, array_of_strings: true, presence: true
+ end
+
+ def self.default
+ []
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/lib/gitlab/web_ide/config/entry/schema/uri.rb b/ee/lib/gitlab/web_ide/config/entry/schema/uri.rb
new file mode 100644
index 0000000000000000000000000000000000000000..901d7c5e07ade1403f69c3731f92a3548a851b8c
--- /dev/null
+++ b/ee/lib/gitlab/web_ide/config/entry/schema/uri.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Gitlab
+ module WebIde
+ class Config
+ module Entry
+ class Schema
+ ##
+ # Entry that represents the URI of a schema
+ #
+ class Uri < ::Gitlab::Config::Entry::Node
+ include ::Gitlab::Config::Entry::Validatable
+
+ validations do
+ validates :config, presence: true, type: String
+ end
+
+ def self.default
+ ''
+ end
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/lib/gitlab/web_ide/config/entry/schemas.rb b/ee/lib/gitlab/web_ide/config/entry/schemas.rb
new file mode 100644
index 0000000000000000000000000000000000000000..a693fa273587b272d90177e122ec28ff75c3c090
--- /dev/null
+++ b/ee/lib/gitlab/web_ide/config/entry/schemas.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gitlab
+ module WebIde
+ class Config
+ module Entry
+ ##
+ # Entry that represents an array of JSON/YAML schemas
+ #
+ class Schemas < ::Gitlab::Config::Entry::Node
+ include ::Gitlab::Config::Entry::Configurable
+ include ::Gitlab::Config::Entry::Validatable
+
+ entry :schema, Entry::Schema, description: 'A JSON/YAML schema definition'
+
+ validations do
+ validates :config, type: Array
+ end
+
+ def skip_config_hash_validation?
+ true
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/spec/lib/ee/gitlab/web_ide/config/entry/global_spec.rb b/ee/spec/lib/ee/gitlab/web_ide/config/entry/global_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..657f946ed784e4a5309e70ec1fbe373260827e7b
--- /dev/null
+++ b/ee/spec/lib/ee/gitlab/web_ide/config/entry/global_spec.rb
@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::WebIde::Config::Entry::Global do
+ let(:global) { described_class.new(hash) }
+
+ describe '.nodes' do
+ 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[terminal schemas])
+ end
+ end
+ end
+
+ context 'when configuration is valid' do
+ context 'when some entries defined' do
+ let(:hash) do
+ {
+ terminal: { before_script: ['ls'], variables: {}, script: 'sleep 10s', services: ['mysql'] },
+ schemas: [{ uri: 'https://someurl.com', match: ['*.gitlab-ci.yml'] }]
+ }
+ end
+
+ 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 2
+ end
+
+ it 'creates node object using valid class' do
+ expect(global.descendants.first)
+ .to be_an_instance_of Gitlab::WebIde::Config::Entry::Terminal
+ expect(global.descendants.second)
+ .to be_an_instance_of Gitlab::WebIde::Config::Entry::Schemas
+ end
+
+ it 'sets correct description for nodes' do
+ expect(global.descendants.first.description)
+ .to eq 'Configuration of the webide terminal.'
+ expect(global.descendants.second.description)
+ .to eq 'Configuration of JSON/YAML schemas.'
+ end
+ end
+
+ context 'when not composed' do
+ describe '#schemas_value' do
+ it 'returns nil' do
+ expect(global.schemas_value).to be nil
+ 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 '#schemas_value' do
+ it 'returns correct value for schemas' do
+ expect(global.schemas_value).to eq([{ uri: 'https://someurl.com', match: ['*.gitlab-ci.yml'] }])
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/ee/spec/lib/gitlab/web_ide/config/entry/schema/match_spec.rb b/ee/spec/lib/gitlab/web_ide/config/entry/schema/match_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..c215f30f54b8e79f8935cef126238167446ad0c9
--- /dev/null
+++ b/ee/spec/lib/gitlab/web_ide/config/entry/schema/match_spec.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::WebIde::Config::Entry::Schema::Match do
+ let(:match) { described_class.new(config) }
+
+ describe 'validations' do
+ context 'when match config value is correct' do
+ let(:config) { ['*.json'] }
+
+ describe '#value' do
+ it 'returns the match glob pattern defined' do
+ expect(match.value).to eq config
+ end
+ end
+
+ describe '#valid?' do
+ it 'is valid' do
+ expect(match).to be_valid
+ end
+ end
+ end
+
+ context 'when value has a wrong type' do
+ let(:config) { { test: true } }
+
+ it 'reports errors about wrong type' do
+ expect(match.errors)
+ .to include 'match config should be an array of strings'
+ end
+ end
+ end
+
+ describe '.default' do
+ it 'returns empty array' do
+ expect(described_class.default).to eq []
+ end
+ end
+end
diff --git a/ee/spec/lib/gitlab/web_ide/config/entry/schema/uri_spec.rb b/ee/spec/lib/gitlab/web_ide/config/entry/schema/uri_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..35ef1eaa8cb082b3357a1369e7a631562b451514
--- /dev/null
+++ b/ee/spec/lib/gitlab/web_ide/config/entry/schema/uri_spec.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::WebIde::Config::Entry::Schema::Uri do
+ let(:uri) { described_class.new(config) }
+
+ describe 'validations' do
+ context 'when uri config value is correct' do
+ let(:config) { 'https://someurl.com' }
+
+ describe '#value' do
+ it 'returns the url defined' do
+ expect(uri.value).to eq config
+ end
+ end
+
+ describe '#valid?' do
+ it 'is valid' do
+ expect(uri).to be_valid
+ end
+ end
+ end
+
+ context 'when value has a wrong type' do
+ let(:config) { { test: true } }
+
+ it 'reports errors about wrong type' do
+ expect(uri.errors)
+ .to include 'uri config should be a string'
+ end
+ end
+ end
+
+ describe '.default' do
+ it 'returns empty string' do
+ expect(described_class.default).to eq ''
+ end
+ end
+end
diff --git a/ee/spec/lib/gitlab/web_ide/config/entry/schema_spec.rb b/ee/spec/lib/gitlab/web_ide/config/entry/schema_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..f189f1a3a12b9a041303b09623e0c27c1d752d8d
--- /dev/null
+++ b/ee/spec/lib/gitlab/web_ide/config/entry/schema_spec.rb
@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::WebIde::Config::Entry::Schema do
+ let(:schema) { described_class.new(hash) }
+
+ 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[uri match])
+ end
+ end
+ end
+
+ context 'when configuration is valid' do
+ context 'when some entries defined' do
+ let(:hash) do
+ { uri: 'https://someurl.com', match: ['*.gitlab-ci.yml'] }
+ end
+
+ describe '#compose!' do
+ before do
+ schema.compose!
+ end
+
+ it 'creates node object for each entry' do
+ expect(schema.descendants.count).to eq 2
+ end
+
+ it 'creates node object using valid class' do
+ expect(schema.descendants.first)
+ .to be_an_instance_of Gitlab::WebIde::Config::Entry::Schema::Uri
+
+ expect(schema.descendants.second)
+ .to be_an_instance_of Gitlab::WebIde::Config::Entry::Schema::Match
+ end
+
+ it 'sets correct description for nodes' do
+ expect(schema.descendants.first.description)
+ .to eq 'The URI of the schema.'
+
+ expect(schema.descendants.second.description)
+ .to eq 'A list of glob expressions to match against the target file.'
+ end
+
+ describe '#leaf?' do
+ it 'is not leaf' do
+ expect(schema).not_to be_leaf
+ end
+ end
+ end
+
+ context 'when composed' do
+ before do
+ schema.compose!
+ end
+
+ describe '#errors' do
+ it 'has no errors' do
+ expect(schema.errors).to be_empty
+ end
+ end
+
+ describe '#uri_value' do
+ it 'returns correct uri' do
+ expect(schema.uri_value).to eq('https://someurl.com')
+ end
+ end
+
+ describe '#match_value' do
+ it 'returns correct value for schemas' do
+ expect(schema.match_value).to eq(['*.gitlab-ci.yml'])
+ end
+ end
+ end
+ end
+ end
+
+ context 'when configuration is not valid' do
+ before do
+ schema.compose!
+ end
+
+ context 'when the config does not have all the required entries' do
+ let(:hash) do
+ {}
+ end
+
+ describe '#errors' do
+ it 'reports errors about the invalid entries' do
+ expect(schema.errors)
+ .to eq [
+ "uri config can't be blank",
+ "match config can't be blank"
+ ]
+ end
+ end
+ end
+
+ context 'when the config has invalid entries' do
+ let(:hash) do
+ { uri: 1, match: [2] }
+ end
+
+ describe '#errors' do
+ it 'reports errors about the invalid entries' do
+ expect(schema.errors)
+ .to eq [
+ "uri config should be a string",
+ "match config should be an array of strings"
+ ]
+ end
+ end
+ end
+ end
+
+ context 'when value is not a hash' do
+ let(:hash) { [] }
+
+ describe '#valid?' do
+ it 'is not valid' do
+ expect(schema).not_to be_valid
+ end
+ end
+
+ describe '#errors' do
+ it 'returns error about invalid type' do
+ expect(schema.errors.first).to match /should be a hash/
+ end
+ end
+ end
+
+ describe '#specified?' do
+ it 'is concrete entry that is defined' do
+ expect(schema.specified?).to be true
+ end
+ end
+end
diff --git a/ee/spec/lib/gitlab/web_ide/config/entry/schemas_spec.rb b/ee/spec/lib/gitlab/web_ide/config/entry/schemas_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..69729704964ca2a29ee9833b284d7412769a675e
--- /dev/null
+++ b/ee/spec/lib/gitlab/web_ide/config/entry/schemas_spec.rb
@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::WebIde::Config::Entry::Schemas do
+ let(:entry) { described_class.new(config) }
+
+ describe 'validations' do
+ before do
+ entry.compose!
+ end
+
+ context 'when entry config value is correct' do
+ let(:config) { [{ uri: 'http://test.uri', match: '*-config.yml' }] }
+
+ it 'is valid' do
+ expect(entry).to be_valid
+ end
+ end
+
+ context 'when entry config value is incorrect' do
+ let(:config) { { incorrect: 'schemas config' } }
+
+ it 'is not valid' do
+ expect(entry).not_to be_valid
+
+ expect(entry.errors.first)
+ .to match /schema/
+ end
+
+ describe '#errors' do
+ it 'reports error about a config type' do
+ expect(entry.errors)
+ .to include 'schemas config should be a array'
+ end
+ end
+ end
+ end
+
+ context 'when composed' do
+ before do
+ entry.compose!
+ end
+
+ describe '#value' do
+ context 'when entry is correct' do
+ let(:config) do
+ [
+ {
+ uri: 'http://test.uri',
+ match: '*-config.yml'
+ }
+ ]
+ end
+
+ it 'returns correct value' do
+ expect(entry.value)
+ .to eq([{
+ uri: 'http://test.uri',
+ match: '*-config.yml'
+ }])
+ end
+ end
+ end
+ end
+end
diff --git a/ee/spec/services/ide/schemas_config_service_spec.rb b/ee/spec/services/ide/schemas_config_service_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..745fc683a066d7bbcd448604d9577b4f4a2c205f
--- /dev/null
+++ b/ee/spec/services/ide/schemas_config_service_spec.rb
@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Ide::SchemasConfigService do
+ let_it_be(:project) { create(:project, :repository) }
+ let_it_be(:user) { create(:user) }
+ let(:sha) { 'sha' }
+ let(:filename) { 'sample.yml' }
+ let(:schema_content) { double(body: '{"title":"Sample schema"}') }
+
+ describe '#execute' do
+ before do
+ project.add_developer(user)
+
+ allow(project.repository).to receive(:blob_data_at).with('sha', anything) do
+ config_content
+ end
+
+ allow(Gitlab::HTTP).to receive(:get).with(anything) do
+ schema_content
+ end
+ end
+
+ subject { described_class.new(project, user, sha: sha, filename: filename).execute }
+
+ context 'content is not valid' do
+ let(:config_content) { 'invalid content' }
+
+ it 'returns an error' do
+ is_expected.to include(
+ status: :error,
+ message: "Invalid configuration format")
+ end
+ end
+
+ context 'when a predefined schema exists for the given filename' do
+ let(:filename) { '.gitlab-ci.yml' }
+
+ before do
+ stub_feature_flags(schema_linting: true)
+ end
+
+ context 'with valid config content' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["*.yml"]}]' }
+
+ it 'uses predefined schema matches' do
+ expect(Gitlab::HTTP).to receive(:get).with('https://json.schemastore.org/gitlab-ci')
+ expect(Gitlab::HTTP).not_to receive(:get).with('https://someurl.com')
+
+ expect(subject[:schema]['title']).to eq "Sample schema"
+ end
+ end
+
+ context 'with invalid config content' do
+ let(:config_content) { '' }
+
+ it 'uses predefined schema matches' do
+ expect(Gitlab::HTTP).to receive(:get).with('https://json.schemastore.org/gitlab-ci')
+
+ expect(subject[:schema]['title']).to eq "Sample schema"
+ end
+ end
+ end
+
+ context 'no schemas are defined' do
+ let(:config_content) { '{}' }
+
+ it 'returns success with an empty object' do
+ is_expected.to include(
+ status: :success,
+ schema: {})
+ end
+ end
+
+ context 'feature :ide_schema_config is not available' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["*.yml"]}]' }
+
+ it 'returns empty object, despite config being defined' do
+ expect(Gitlab::HTTP).not_to receive(:get).with("https://someurl.com")
+ expect(subject[:schema]).to eq({})
+ end
+ end
+
+ context 'feature :ide_schema_config is available' do
+ before do
+ allow(project).to receive(:feature_available?).with(:ide_schema_config) { true }
+ end
+
+ context 'schemas are defined and a matching schema is found and valid' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["*.yml"]}]' }
+
+ it 'returns schema successfully' do
+ expect(Gitlab::HTTP).to receive(:get).with("https://someurl.com")
+ expect(subject[:schema]['title']).to eq "Sample schema"
+ end
+ end
+
+ context 'schemas are defined and a matching schema is found and but the schema is not a valid JSON' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["*.yml"]}]' }
+ let(:schema_content) { double(body: 'invalid json!') }
+
+ it 'returns schema successfully' do
+ expect(Gitlab::HTTP).to receive(:get).with("https://someurl.com")
+ expect(subject[:status]).to eq(:error)
+ expect(subject[:message]).to include('unexpected character () at line 1, column 1')
+ end
+ end
+
+ context 'schemas are defined and but no matching schema found' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["*.json"]}]' }
+
+ it 'returns empty schema object' do
+ expect(Gitlab::HTTP).not_to receive(:get).with("https://someurl.com")
+ expect(subject[:schema]).to eq({})
+ end
+ end
+
+ context 'nested schema filename with "**" in match uri' do
+ let(:config_content) { 'schemas: [{uri: "https://someurl.com", match: ["data/somepath/**/*.yml"]}]' }
+ let(:filename) { 'data/somepath/unreleased/changelog/path/changelog.yml' }
+
+ it 'returns schema successfully' do
+ expect(Gitlab::HTTP).to receive(:get).with("https://someurl.com")
+ expect(subject[:schema]['title']).to eq "Sample schema"
+ end
+ end
+ end
+ end
+end
diff --git a/lib/gitlab/web_ide/config.rb b/lib/gitlab/web_ide/config.rb
index 3b1fa162b533ace9ce67429b40fcfebea7d0ba14..b2ab5c0b6e39d1e9546b9452a12e3de29515877a 100644
--- a/lib/gitlab/web_ide/config.rb
+++ b/lib/gitlab/web_ide/config.rb
@@ -34,6 +34,10 @@ def terminal_value
@global.terminal_value
end
+ def schemas_value
+ @global.schemas_value
+ end
+
private
def build_config(config, opts = {})
diff --git a/lib/gitlab/web_ide/config/entry/global.rb b/lib/gitlab/web_ide/config/entry/global.rb
index 50c3f2d294f40731c4b44dbe7d024bc0baa93488..2c67c7d02d48b1625e82c00ad6fa4c91a46d5a44 100644
--- a/lib/gitlab/web_ide/config/entry/global.rb
+++ b/lib/gitlab/web_ide/config/entry/global.rb
@@ -12,18 +12,22 @@ class Global < ::Gitlab::Config::Entry::Node
include ::Gitlab::Config::Entry::Configurable
include ::Gitlab::Config::Entry::Attributable
- ALLOWED_KEYS = %i[terminal].freeze
+ def self.allowed_keys
+ %i[terminal].freeze
+ end
validations do
- validates :config, allowed_keys: ALLOWED_KEYS
+ validates :config, allowed_keys: Global.allowed_keys
end
+ attributes allowed_keys
+
entry :terminal, Entry::Terminal,
description: 'Configuration of the webide terminal.'
-
- attributes :terminal
end
end
end
end
end
+
+::Gitlab::WebIde::Config::Entry::Global.prepend_if_ee('EE::Gitlab::WebIde::Config::Entry::Global')
diff --git a/spec/controllers/projects/web_ide_schemas_controller_spec.rb b/spec/controllers/projects/web_ide_schemas_controller_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..fbec941aecc458626ec08bd027e098858ad3c6c1
--- /dev/null
+++ b/spec/controllers/projects/web_ide_schemas_controller_spec.rb
@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Projects::WebIdeSchemasController do
+ let_it_be(:developer) { create(:user) }
+ let_it_be(:project) { create(:project, :private, :repository, namespace: developer.namespace) }
+
+ before do
+ project.add_developer(developer)
+
+ sign_in(user)
+ end
+
+ describe 'GET show' do
+ let(:user) { developer }
+ let(:branch) { 'master' }
+
+ subject do
+ get :show, params: {
+ namespace_id: project.namespace.to_param,
+ project_id: project,
+ branch: branch,
+ filename: 'package.json'
+ }
+ end
+
+ before do
+ allow_next_instance_of(::Ide::SchemasConfigService) do |instance|
+ allow(instance).to receive(:execute).and_return(result)
+ end
+ end
+
+ context 'when branch is invalid' do
+ let(:branch) { 'non-existent' }
+
+ it 'returns 422' do
+ subject
+
+ expect(response).to have_gitlab_http_status(:unprocessable_entity)
+ end
+ end
+
+ context 'when a valid schema exists' do
+ let(:result) { { status: :success, schema: { schema: 'Sample Schema' } } }
+
+ it 'returns the schema' do
+ subject
+
+ expect(response).to have_gitlab_http_status(:ok)
+ expect(response.body).to eq('{"schema":"Sample Schema"}')
+ end
+ end
+
+ context 'when an error occurs parsing the schema' do
+ let(:result) { { status: :error, message: 'Some error occured' } }
+
+ it 'returns 422 with the error' do
+ subject
+
+ expect(response).to have_gitlab_http_status(:unprocessable_entity)
+ expect(response.body).to eq('{"status":"error","message":"Some error occured"}')
+ end
+ end
+ end
+end
diff --git a/spec/controllers/projects/web_ide_terminals_controller_spec.rb b/spec/controllers/projects/web_ide_terminals_controller_spec.rb
index 2ae5899c25822eef9fd2e8b0a08d6dad1323739f..3eb3d5da351a5f7ecfa7899036557fdf99869da8 100644
--- a/spec/controllers/projects/web_ide_terminals_controller_spec.rb
+++ b/spec/controllers/projects/web_ide_terminals_controller_spec.rb
@@ -113,7 +113,7 @@
let(:result) { { status: :success } }
before do
- allow_next_instance_of(::Ci::WebIdeConfigService) do |instance|
+ allow_next_instance_of(::Ide::TerminalConfigService) do |instance|
allow(instance).to receive(:execute).and_return(result)
end
diff --git a/spec/lib/gitlab/web_ide/config/entry/global_spec.rb b/spec/lib/gitlab/web_ide/config/entry/global_spec.rb
index 3a50667163ba5b60239d9683f112e8deca05ab3e..3e29bf89785c5e6c7632168c6d63f47be5665ec7 100644
--- a/spec/lib/gitlab/web_ide/config/entry/global_spec.rb
+++ b/spec/lib/gitlab/web_ide/config/entry/global_spec.rb
@@ -12,8 +12,7 @@
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[terminal])
+ expect(described_class.nodes.keys).to match_array(described_class.allowed_keys)
end
end
end
@@ -34,7 +33,7 @@
end
it 'creates node object for each entry' do
- expect(global.descendants.count).to eq 1
+ expect(global.descendants.count).to eq described_class.allowed_keys.length
end
it 'creates node object using valid class' do
diff --git a/spec/services/ci/web_ide_config_service_spec.rb b/spec/services/ide/base_config_service_spec.rb
similarity index 53%
rename from spec/services/ci/web_ide_config_service_spec.rb
rename to spec/services/ide/base_config_service_spec.rb
index 437b468cec8f1dce3c910dc6cce4aa3fe20fad1b..debdc6e58096a66020dfc951f8079a9dda21729c 100644
--- a/spec/services/ci/web_ide_config_service_spec.rb
+++ b/spec/services/ide/base_config_service_spec.rb
@@ -2,7 +2,7 @@
require 'spec_helper'
-RSpec.describe Ci::WebIdeConfigService do
+RSpec.describe Ide::BaseConfigService do
let_it_be(:project) { create(:project, :repository) }
let_it_be(:user) { create(:user) }
let(:sha) { 'sha' }
@@ -47,44 +47,6 @@
message: "Invalid configuration format")
end
end
-
- context 'content is valid, but terminal not defined' do
- let(:config_content) { '{}' }
-
- it 'returns success' do
- is_expected.to include(
- status: :success,
- terminal: nil)
- end
- end
-
- context 'content is valid, with enabled terminal' do
- let(:config_content) { 'terminal: {}' }
-
- it 'returns success' do
- is_expected.to include(
- status: :success,
- terminal: {
- tag_list: [],
- yaml_variables: [],
- options: { script: ["sleep 60"] }
- })
- end
- end
-
- context 'content is valid, with custom terminal' do
- let(:config_content) { 'terminal: { before_script: [ls] }' }
-
- it 'returns success' do
- is_expected.to include(
- status: :success,
- terminal: {
- tag_list: [],
- yaml_variables: [],
- options: { before_script: ["ls"], script: ["sleep 60"] }
- })
- end
- end
end
end
end
diff --git a/spec/services/ide/schemas_config_service_spec.rb b/spec/services/ide/schemas_config_service_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..19e5ca9e87dca755a799916b3ec693bc749470dd
--- /dev/null
+++ b/spec/services/ide/schemas_config_service_spec.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Ide::SchemasConfigService do
+ let_it_be(:project) { create(:project, :repository) }
+ let_it_be(:user) { create(:user) }
+ let(:filename) { 'sample.yml' }
+ let(:schema_content) { double(body: '{"title":"Sample schema"}') }
+
+ describe '#execute' do
+ before do
+ project.add_developer(user)
+
+ allow(Gitlab::HTTP).to receive(:get).with(anything) do
+ schema_content
+ end
+ end
+
+ subject { described_class.new(project, user, filename: filename).execute }
+
+ context 'feature flag schema_linting is enabled', unless: Gitlab.ee? do
+ before do
+ stub_feature_flags(schema_linting: true)
+ end
+
+ context 'when no predefined schema exists for the given filename' do
+ it 'returns an empty object' do
+ is_expected.to include(
+ status: :success,
+ schema: {})
+ end
+ end
+
+ context 'when a predefined schema exists for the given filename' do
+ let(:filename) { '.gitlab-ci.yml' }
+
+ it 'uses predefined schema matches' do
+ expect(Gitlab::HTTP).to receive(:get).with('https://json.schemastore.org/gitlab-ci')
+ expect(subject[:schema]['title']).to eq "Sample schema"
+ end
+ end
+ end
+
+ context 'feature flag schema_linting is disabled', unless: Gitlab.ee? do
+ it 'returns an empty object' do
+ is_expected.to include(
+ status: :success,
+ schema: {})
+ end
+ end
+ end
+end
diff --git a/spec/services/ide/terminal_config_service_spec.rb b/spec/services/ide/terminal_config_service_spec.rb
new file mode 100644
index 0000000000000000000000000000000000000000..d6c4f7a2a69b47c2cbee62a4438354b297426611
--- /dev/null
+++ b/spec/services/ide/terminal_config_service_spec.rb
@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Ide::TerminalConfigService do
+ let_it_be(:project) { create(:project, :repository) }
+ let_it_be(:user) { create(:user) }
+ let(:sha) { 'sha' }
+
+ describe '#execute' do
+ subject { described_class.new(project, user, sha: sha).execute }
+
+ before do
+ project.add_developer(user)
+
+ allow(project.repository).to receive(:blob_data_at).with('sha', anything) do
+ config_content
+ end
+ end
+
+ context 'content is not valid' do
+ let(:config_content) { 'invalid content' }
+
+ it 'returns an error' do
+ is_expected.to include(
+ status: :error,
+ message: "Invalid configuration format")
+ end
+ end
+
+ context 'terminal not defined' do
+ let(:config_content) { '{}' }
+
+ it 'returns success' do
+ is_expected.to include(
+ status: :success,
+ terminal: nil)
+ end
+ end
+
+ context 'terminal enabled' do
+ let(:config_content) { 'terminal: {}' }
+
+ it 'returns success' do
+ is_expected.to include(
+ status: :success,
+ terminal: {
+ tag_list: [],
+ yaml_variables: [],
+ options: { script: ["sleep 60"] }
+ })
+ end
+ end
+
+ context 'custom terminal enabled' do
+ let(:config_content) { 'terminal: { before_script: [ls] }' }
+
+ it 'returns success' do
+ is_expected.to include(
+ status: :success,
+ terminal: {
+ tag_list: [],
+ yaml_variables: [],
+ options: { before_script: ["ls"], script: ["sleep 60"] }
+ })
+ end
+ end
+ end
+end