Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-02-18 13:34:06 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-02-18 13:34:06 +0300
commit859a6fb938bb9ee2a317c46dfa4fcc1af49608f0 (patch)
treed7f2700abe6b4ffcb2dcfc80631b2d87d0609239 /lib/gitlab/template
parent446d496a6d000c73a304be52587cd9bbc7493136 (diff)
Add latest changes from gitlab-org/gitlab@13-9-stable-eev13.9.0-rc42
Diffstat (limited to 'lib/gitlab/template')
-rw-r--r--lib/gitlab/template/base_template.rb41
-rw-r--r--lib/gitlab/template/finders/global_template_finder.rb7
-rw-r--r--lib/gitlab/template/finders/repo_template_finder.rb6
-rw-r--r--lib/gitlab/template/gitlab_ci_yml_template.rb12
-rw-r--r--lib/gitlab/template/issue_template.rb10
-rw-r--r--lib/gitlab/template/merge_request_template.rb10
6 files changed, 67 insertions, 19 deletions
diff --git a/lib/gitlab/template/base_template.rb b/lib/gitlab/template/base_template.rb
index b659bff52ad..0f933a61598 100644
--- a/lib/gitlab/template/base_template.rb
+++ b/lib/gitlab/template/base_template.rb
@@ -8,6 +8,7 @@ module Gitlab
def initialize(path, project = nil, category: nil)
@path = path
@category = category
+ @project = project
@finder = self.class.finder(project)
end
@@ -31,6 +32,10 @@ module Gitlab
# override with a comment to be placed at the top of the blob.
end
+ def project_id
+ @project&.id
+ end
+
# Present for compatibility with license templates, which can replace text
# like `[fullname]` with a user-specified string. This is a no-op for
# other templates
@@ -76,7 +81,7 @@ module Gitlab
end
# Defines which strategy will be used to get templates files
- # RepoTemplateFinder - Finds templates on project repository, templates are filtered perproject
+ # RepoTemplateFinder - Finds templates on project repository, templates are filtered per project
# GlobalTemplateFinder - Finds templates on gitlab installation source, templates can be used in all projects
def finder(project = nil)
raise NotImplementedError
@@ -95,19 +100,29 @@ module Gitlab
File.join(base_dir, categories[category])
end
- # If template is organized by category it returns { category_name: [{ name: template_name }, { name: template2_name }] }
- # If no category is present returns [{ name: template_name }, { name: template2_name}]
- def dropdown_names(project = nil)
- return [] if project && !project.repository.exists?
+ # `repository_template_names` - reads through Gitaly the actual templates names within a
+ # given project's repository. This is only used by issue and merge request templates,
+ # that need to call this once and then cache the returned value.
+ #
+ # `template_names` - is an alias to `repository_template_names`. It would read through
+ # Gitaly the actual template names within a given project's repository for all file templates
+ # other than `issue` and `merge request` description templates, which would instead
+ # overwrite the `template_names` method to return a redis cached version, by reading cached values
+ # from `repository.issue_template_names_by_category` and `repository.merge_request_template_names_by_category`
+ # methods.
+ def repository_template_names(project)
+ template_names_by_category(self.all(project))
+ end
+ alias_method :template_names, :repository_template_names
- if categories.any?
- categories.keys.map do |category|
- files = self.by_category(category, project)
- [category, files.map { |t| { name: t.name } }]
- end.to_h
- else
- files = self.all(project)
- files.map { |t| { name: t.name } }
+ def template_names_by_category(items)
+ grouped = items.group_by(&:category)
+ categories = grouped.keys
+
+ categories.each_with_object({}) do |category, hash|
+ hash[category] = grouped[category].map do |item|
+ { name: item.name, id: item.key, key: item.key, project_id: item.try(:project_id) }
+ end
end
end
diff --git a/lib/gitlab/template/finders/global_template_finder.rb b/lib/gitlab/template/finders/global_template_finder.rb
index 9b39d386674..6d2677175e6 100644
--- a/lib/gitlab/template/finders/global_template_finder.rb
+++ b/lib/gitlab/template/finders/global_template_finder.rb
@@ -5,9 +5,10 @@ module Gitlab
module Template
module Finders
class GlobalTemplateFinder < BaseTemplateFinder
- def initialize(base_dir, extension, categories = {}, excluded_patterns: [])
+ def initialize(base_dir, extension, categories = {}, include_categories_for_file = {}, excluded_patterns: [])
@categories = categories
@extension = extension
+ @include_categories_for_file = include_categories_for_file
@excluded_patterns = excluded_patterns
super(base_dir)
@@ -47,7 +48,9 @@ module Gitlab
end
def select_directory(file_name)
- @categories.keys.find do |category|
+ categories = @categories
+ categories.merge!(@include_categories_for_file[file_name]) if @include_categories_for_file[file_name].present?
+ categories.keys.find do |category|
File.exist?(File.join(category_directory(category), file_name))
end
end
diff --git a/lib/gitlab/template/finders/repo_template_finder.rb b/lib/gitlab/template/finders/repo_template_finder.rb
index 8e234148a63..9f0ba97bcdf 100644
--- a/lib/gitlab/template/finders/repo_template_finder.rb
+++ b/lib/gitlab/template/finders/repo_template_finder.rb
@@ -11,8 +11,8 @@ module Gitlab
def initialize(project, base_dir, extension, categories = {})
@categories = categories
@extension = extension
- @repository = project.repository
- @commit = @repository.head_commit if @repository.exists?
+ @repository = project&.repository
+ @commit = @repository.head_commit if @repository&.exists?
super(base_dir)
end
@@ -51,7 +51,7 @@ module Gitlab
private
def select_directory(file_name)
- return [] unless @commit
+ return unless @commit
# Insert root as directory
directories = ["", *@categories.keys]
diff --git a/lib/gitlab/template/gitlab_ci_yml_template.rb b/lib/gitlab/template/gitlab_ci_yml_template.rb
index c295cc75da5..01158cafc4f 100644
--- a/lib/gitlab/template/gitlab_ci_yml_template.rb
+++ b/lib/gitlab/template/gitlab_ci_yml_template.rb
@@ -25,6 +25,12 @@ module Gitlab
}
end
+ def include_categories_for_file
+ {
+ "SAST#{self.extension}" => { 'Security' => 'Security' }
+ }
+ end
+
def excluded_patterns
strong_memoize(:excluded_patterns) do
BASE_EXCLUDED_PATTERNS + additional_excluded_patterns
@@ -41,7 +47,11 @@ module Gitlab
def finder(project = nil)
Gitlab::Template::Finders::GlobalTemplateFinder.new(
- self.base_dir, self.extension, self.categories, excluded_patterns: self.excluded_patterns
+ self.base_dir,
+ self.extension,
+ self.categories,
+ self.include_categories_for_file,
+ excluded_patterns: self.excluded_patterns
)
end
end
diff --git a/lib/gitlab/template/issue_template.rb b/lib/gitlab/template/issue_template.rb
index 01b191733d4..3049f43b322 100644
--- a/lib/gitlab/template/issue_template.rb
+++ b/lib/gitlab/template/issue_template.rb
@@ -15,6 +15,16 @@ module Gitlab
def finder(project)
Gitlab::Template::Finders::RepoTemplateFinder.new(project, self.base_dir, self.extension, self.categories)
end
+
+ def template_names(project)
+ return {} unless project&.repository&.exists?
+
+ # here we rely on project.repository caching mechanism. Ideally we would want the template finder to have its
+ # own caching mechanism to avoid the back and forth call jumps between finder and model.
+ #
+ # follow-up issue: https://gitlab.com/gitlab-org/gitlab/-/issues/300279
+ project.repository.issue_template_names_by_category
+ end
end
end
end
diff --git a/lib/gitlab/template/merge_request_template.rb b/lib/gitlab/template/merge_request_template.rb
index 357b31cd82e..9442f3b13fb 100644
--- a/lib/gitlab/template/merge_request_template.rb
+++ b/lib/gitlab/template/merge_request_template.rb
@@ -15,6 +15,16 @@ module Gitlab
def finder(project)
Gitlab::Template::Finders::RepoTemplateFinder.new(project, self.base_dir, self.extension, self.categories)
end
+
+ def template_names(project)
+ return {} unless project&.repository&.exists?
+
+ # here we rely on project.repository caching mechanism. Ideally we would want the template finder to have its
+ # own caching mechanism to avoid the back and forth call jumps between finder and model.
+ #
+ # follow-up issue: https://gitlab.com/gitlab-org/gitlab/-/issues/300279
+ project.repository.merge_request_template_names_by_category
+ end
end
end
end