foreman_templates 10.0.1 → 10.0.3

data/app/assets/javascripts/foreman_templates/locale/sv_SE/foreman_templates.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_templates": {
       "": {
-        "Project-Id-Version": "foreman_templates 10.0.1",
+        "Project-Id-Version": "foreman_templates 10.0.3",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-14 12:27+0000",
         "Last-Translator": "johnny.westerlund <johnny.westerlund@gmail.com>, 2023",
@@ -47,6 +47,9 @@
       "Commit message": [
         ""
       ],
+      "Custom HTTP proxy": [
+        ""
+      ],
       "Custom commit message for templates export": [
         ""
       ],
@@ -56,6 +59,9 @@
       "Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata": [
         ""
       ],
+      "Directory within Git repo containing the templates.": [
+        ""
+      ],
       "Dirname": [
         ""
       ],
@@ -71,9 +77,24 @@
       "Force import": [
         ""
       ],
+      "Global default HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy policy": [
+        ""
+      ],
+      "HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter.": [
+        ""
+      ],
       "How to handle lock for imported templates?": [
         ""
       ],
+      "ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`": [
+        ""
+      ],
       "Import": [
         "Importera"
       ],
@@ -89,6 +110,9 @@
       "Initiate Import": [
         ""
       ],
+      "Invalid repo format, must start with one of: ": [
+        ""
+      ],
       "Keep": [
         ""
       ],
@@ -125,6 +149,9 @@
       "New": [
         "Ny"
       ],
+      "No HTTP proxy": [
+        ""
+      ],
       "Override the default repo from settings.": [
         ""
       ],
@@ -152,6 +179,12 @@
       "Repo": [
         ""
       ],
+      "Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page.": [
+        ""
+      ],
+      "Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one.": [
+        ""
+      ],
       "Should importing overwrite locked templates?": [
         ""
       ],
@@ -170,9 +203,6 @@
       "Template Sync": [
         ""
       ],
-      "The directory within Git repo containing the templates": [
-        ""
-      ],
       "The directory within the Git repo containing the templates": [
         ""
       ],

data/app/assets/javascripts/foreman_templates/locale/zh_CN/foreman_templates.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_templates": {
       "": {
-        "Project-Id-Version": "foreman_templates 10.0.1",
+        "Project-Id-Version": "foreman_templates 10.0.3",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-14 12:27+0000",
         "Last-Translator": "Ewoud Kohl van Wijngaarden <ewoud+transifex@kohlvanwijngaarden.nl>, 2024",
@@ -47,6 +47,9 @@
       "Commit message": [
         "提交消息"
       ],
+      "Custom HTTP proxy": [
+        ""
+      ],
       "Custom commit message for templates export": [
         "模板导出的自定义提交消息"
       ],
@@ -56,6 +59,9 @@
       "Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata": [
         "默认元数据导出模式，刷新后重新渲染元数据，保留将保留现有元数据，删除不包含元数据的导出模板"
       ],
+      "Directory within Git repo containing the templates.": [
+        ""
+      ],
       "Dirname": [
         "Dirname"
       ],
@@ -71,9 +77,24 @@
       "Force import": [
         "强制导入"
       ],
+      "Global default HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy policy": [
+        ""
+      ],
+      "HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter.": [
+        ""
+      ],
       "How to handle lock for imported templates?": [
         "如何处理导入的模板锁定？"
       ],
+      "ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`": [
+        ""
+      ],
       "Import": [
         "导入"
       ],
@@ -89,6 +110,9 @@
       "Initiate Import": [
         "启动导入"
       ],
+      "Invalid repo format, must start with one of: ": [
+        ""
+      ],
       "Keep": [
         "保持"
       ],
@@ -125,6 +149,9 @@
       "New": [
         "新"
       ],
+      "No HTTP proxy": [
+        ""
+      ],
       "Override the default repo from settings.": [
         "覆盖设置中的默认仓库。"
       ],
@@ -152,6 +179,12 @@
       "Repo": [
         "仓库"
       ],
+      "Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page.": [
+        ""
+      ],
+      "Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one.": [
+        ""
+      ],
       "Should importing overwrite locked templates?": [
         "是否应该导入覆盖锁定的模板？"
       ],
@@ -170,9 +203,6 @@
       "Template Sync": [
         "模板同步"
       ],
-      "The directory within Git repo containing the templates": [
-        "Git 仓库中包含模板的目录"
-      ],
       "The directory within the Git repo containing the templates": [
         "Git 仓库中包含模板的目录"
       ],

data/app/assets/javascripts/foreman_templates/locale/zh_TW/foreman_templates.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_templates": {
       "": {
-        "Project-Id-Version": "foreman_templates 10.0.1",
+        "Project-Id-Version": "foreman_templates 10.0.3",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-14 12:27+0000",
         "Last-Translator": "Bryan Kearney <bryan.kearney@gmail.com>, 2023",
@@ -47,6 +47,9 @@
       "Commit message": [
         ""
       ],
+      "Custom HTTP proxy": [
+        ""
+      ],
       "Custom commit message for templates export": [
         ""
       ],
@@ -56,6 +59,9 @@
       "Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata": [
         ""
       ],
+      "Directory within Git repo containing the templates.": [
+        ""
+      ],
       "Dirname": [
         ""
       ],
@@ -71,9 +77,24 @@
       "Force import": [
         ""
       ],
+      "Global default HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy": [
+        ""
+      ],
+      "HTTP proxy policy": [
+        ""
+      ],
+      "HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter.": [
+        ""
+      ],
       "How to handle lock for imported templates?": [
         ""
       ],
+      "ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`": [
+        ""
+      ],
       "Import": [
         "匯入"
       ],
@@ -89,6 +110,9 @@
       "Initiate Import": [
         ""
       ],
+      "Invalid repo format, must start with one of: ": [
+        ""
+      ],
       "Keep": [
         ""
       ],
@@ -125,6 +149,9 @@
       "New": [
         "新增"
       ],
+      "No HTTP proxy": [
+        ""
+      ],
       "Override the default repo from settings.": [
         ""
       ],
@@ -152,6 +179,12 @@
       "Repo": [
         "軟體庫"
       ],
+      "Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page.": [
+        ""
+      ],
+      "Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one.": [
+        ""
+      ],
       "Should importing overwrite locked templates?": [
         ""
       ],
@@ -170,9 +203,6 @@
       "Template Sync": [
         ""
       ],
-      "The directory within Git repo containing the templates": [
-        ""
-      ],
       "The directory within the Git repo containing the templates": [
         ""
       ],

data/app/controllers/api/v2/template_controller.rb

@@ -12,7 +12,9 @@ module Api
         param :repo, String, :required => false, :desc => N_("Override the default repo from settings.")
         param :filter, String, :required => false, :desc => N_("Export templates with names matching this regex (case-insensitive; snippets are not filtered).")
         param :negate, :bool, :required => false, :desc => N_("Negate the prefix (for purging).")
-        param :dirname, String, :required => false, :desc => N_("The directory within Git repo containing the templates")
+        param :dirname, String, :required => false, :desc => N_("Directory within Git repo containing the templates.")
+        param :http_proxy_policy, ForemanTemplates.http_proxy_policy_types.keys, :required => false, :desc => N_("HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter.")
+        param :http_proxy_id, :number, :required => false, :desc => N_("ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`")
       end
 
       api :POST, "/templates/import/", N_("Initiate Import")

data/app/controllers/concerns/foreman/controller/parameters/template_params.rb

@@ -7,7 +7,7 @@ module Foreman
 
         class_methods do
           def filter_params_list
-            %i(verbose repo branch dirname filter negate metadata_export_mode)
+            %i(verbose repo branch dirname filter negate metadata_export_mode http_proxy_policy http_proxy_id)
           end
 
           def extra_import_params

data/app/controllers/ui_template_syncs_controller.rb

@@ -49,6 +49,26 @@ class UITemplateSyncsController < ApplicationController
   private
 
   def setting_definitions(short_names)
-    short_names.map { |name| Foreman.settings.find("template_sync_#{name}") }
+    settings = short_names.map { |name| Foreman.settings.find("template_sync_#{name}") }
+    proxy_policy_setting = Foreman.settings.find('template_sync_http_proxy_policy').dup
+    proxy_id_setting = http_proxy_id_setting
+    # if default value is 'Custom HTTP proxy' but there is no proxy to select, value must be changed
+    proxy_policy_setting.value = proxy_policy_setting.default = 'none' if proxy_id_setting.value == '' && proxy_policy_setting.value == 'selected'
+    settings << proxy_policy_setting
+    settings << proxy_id_setting
+    settings
+  end
+
+  def http_proxy_id_setting
+    proxy_list = HttpProxy.authorized(:view_http_proxies).with_taxonomy_scope.each_with_object({}) { |proxy, hash| hash[proxy.id] = proxy.name }
+    default_proxy_id = proxy_list.keys.first || ""
+    OpenStruct.new(id: 'template_sync_http_proxy_id',
+      name: 'template_sync_http_proxy_id',
+      description: N_('Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page.'),
+      settings_type: :string,
+      value: default_proxy_id,
+      default: default_proxy_id,
+      full_name: N_('HTTP proxy'),
+      select_values: proxy_list)
   end
 end

data/app/services/foreman_templates/action.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 module ForemanTemplates
   class Action
     delegate :logger, :to => :Rails
@@ -15,7 +17,7 @@ module ForemanTemplates
     end
 
     def self.setting_overrides
-      %i(verbose prefix dirname filter repo negate branch)
+      %i(verbose prefix dirname filter repo negate branch http_proxy_policy)
     end
 
     def method_missing(method, *args, &block)
@@ -53,9 +55,38 @@ module ForemanTemplates
     private
 
     def assign_attributes(args = {})
+      @http_proxy_id = args[:http_proxy_id]
       self.class.setting_overrides.each do |attribute|
         instance_variable_set("@#{attribute}", args[attribute.to_sym] || Setting["template_sync_#{attribute}".to_sym])
       end
     end
+
+    protected
+
+    def init_git_repo
+      git_repo = Git.init(@dir)
+
+      case @http_proxy_policy
+      when 'global'
+        http_proxy_url = Setting[:http_proxy]
+      when 'selected'
+        http_proxy = HttpProxy.authorized(:view_http_proxies).with_taxonomy_scope.find(@http_proxy_id)
+        http_proxy_url = http_proxy.full_url
+
+        if URI(http_proxy_url).scheme == 'https' && http_proxy.cacert.present?
+          proxy_cert = "#{@dir}/.git/foreman_templates_proxy_cert_#{SecureRandom.hex(8)}.crt"
+          File.write(proxy_cert, http_proxy.cacert)
+          git_repo.config('http.proxySSLCAInfo', proxy_cert)
+        end
+      end
+
+      if http_proxy_url.present?
+        git_repo.config('http.proxy', http_proxy_url)
+      end
+
+      git_repo.add_remote('origin', @repo)
+      logger.debug "cloned '#{@repo}' to '#{@dir}'"
+      git_repo
+    end
   end
 end

data/app/services/foreman_templates/parse_result.rb

@@ -16,7 +16,7 @@ module ForemanTemplates
         :additional_errors => @additional_errors,
         :additional_info => @additional_info,
         :exception => @exception&.message,
-        :validation_errors => errors,
+        :validation_errors => transformed_errors,
         :file => @template_file,
         :type => @template.present? ? @template.class.name.underscore : nil
       }
@@ -27,9 +27,7 @@ module ForemanTemplates
     end
 
     def errors
-      @template&.errors&.messages&.transform_values do |v|
-        v.join(', ')
-      end
+      @template&.errors
     end
 
     def corrupted_metadata
@@ -99,5 +97,13 @@ module ForemanTemplates
         nil
       end
     end
+
+    private
+
+    def transformed_errors
+      return {} unless errors
+
+      errors.to_hash.transform_values(&:last)
+    end
   end
 end

data/app/services/foreman_templates/template_exporter.rb

@@ -31,8 +31,8 @@ module ForemanTemplates
       @dir = Dir.mktmpdir
       return if branch_missing?
 
-      git_repo = Git.clone(@repo, @dir)
-      logger.debug "cloned '#{@repo}' to '#{@dir}'"
+      git_repo = init_git_repo
+      git_repo.fetch
 
       setup_git_branch git_repo
       dump_files!

data/app/services/foreman_templates/template_importer.rb

@@ -32,9 +32,9 @@ module ForemanTemplates
       @dir = Dir.mktmpdir
 
       begin
-        logger.debug "cloned '#{@repo}' to '#{@dir}'"
-        gitrepo = Git.clone(@repo, @dir)
-        if @branch
+        gitrepo = init_git_repo
+        gitrepo.fetch
+        if @branch.present?
           logger.debug "checking out branch '#{@branch}'"
           gitrepo.checkout(@branch)
         end

data/lib/foreman_templates/engine.rb

@@ -94,6 +94,12 @@ module ForemanTemplates
               description: N_('Custom commit message for templates export'),
               default: 'Templates export made by a Foreman user',
               full_name: N_('Commit message'))
+            setting('template_sync_http_proxy_policy',
+              type: :string,
+              description: N_('Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one.'),
+              default: 'global',
+              full_name: N_('HTTP proxy policy'),
+              collection: -> { ForemanTemplates.http_proxy_policy_types })
           end
         end
 

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = "10.0.1".freeze
+  VERSION = "10.0.3".freeze
 end

data/lib/foreman_templates.rb

@@ -16,4 +16,8 @@ module ForemanTemplates
   def self.metadata_export_mode_types
     { 'refresh' => _('Refresh'), 'keep' => _('Keep'), 'remove' => _('Remove') }
   end
+
+  def self.http_proxy_policy_types
+    { 'global' => _('Global default HTTP proxy'), 'none' => _('No HTTP proxy'), 'selected' => _('Custom HTTP proxy') }
+  end
 end

data/locale/cs_CZ/foreman_templates.po

@@ -8,7 +8,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_templates 10.0.1\n"
+"Project-Id-Version: foreman_templates 10.0.3\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2019-10-14 12:27+0000\n"
 "Last-Translator: Pavel Borecki <pavel.borecki@gmail.com>, 2023\n"
@@ -51,6 +51,9 @@ msgstr ""
 msgid "Commit message"
 msgstr ""
 
+msgid "Custom HTTP proxy"
+msgstr ""
+
 msgid "Custom commit message for templates export"
 msgstr ""
 
@@ -60,6 +63,9 @@ msgstr "Výchozí větev v Git repozitáři"
 msgid "Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata"
 msgstr ""
 
+msgid "Directory within Git repo containing the templates."
+msgstr ""
+
 msgid "Dirname"
 msgstr ""
 
@@ -75,9 +81,24 @@ msgstr ""
 msgid "Force import"
 msgstr "Vynutit import"
 
+msgid "Global default HTTP proxy"
+msgstr ""
+
+msgid "HTTP proxy"
+msgstr ""
+
+msgid "HTTP proxy policy"
+msgstr ""
+
+msgid "HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter."
+msgstr ""
+
 msgid "How to handle lock for imported templates?"
 msgstr ""
 
+msgid "ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`"
+msgstr ""
+
 msgid "Import"
 msgstr "Import"
 
@@ -93,6 +114,9 @@ msgstr "Zahájit export"
 msgid "Initiate Import"
 msgstr "Zahájit import"
 
+msgid "Invalid repo format, must start with one of: "
+msgstr ""
+
 msgid "Keep"
 msgstr "Ponechat"
 
@@ -129,6 +153,9 @@ msgstr "Nikdy"
 msgid "New"
 msgstr "Nové"
 
+msgid "No HTTP proxy"
+msgstr ""
+
 msgid "Override the default repo from settings."
 msgstr ""
 
@@ -156,6 +183,12 @@ msgstr "Odebrat"
 msgid "Repo"
 msgstr "Repozitář"
 
+msgid "Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page."
+msgstr ""
+
+msgid "Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one."
+msgstr ""
+
 msgid "Should importing overwrite locked templates?"
 msgstr ""
 
@@ -174,9 +207,6 @@ msgstr ""
 msgid "Template Sync"
 msgstr ""
 
-msgid "The directory within Git repo containing the templates"
-msgstr ""
-
 msgid "The directory within the Git repo containing the templates"
 msgstr ""
 

data/locale/de/foreman_templates.po

@@ -13,7 +13,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_templates 10.0.1\n"
+"Project-Id-Version: foreman_templates 10.0.3\n"
 "Report-Msgid-Bugs-To: \n"
 "PO-Revision-Date: 2019-10-14 12:27+0000\n"
 "Last-Translator: pdolinic, 2023\n"
@@ -54,6 +54,9 @@ msgstr "Wählen Sie die Ausführlichkeit für Importvorlagen für Rake-Aufgaben"
 msgid "Commit message"
 msgstr ""
 
+msgid "Custom HTTP proxy"
+msgstr ""
+
 msgid "Custom commit message for templates export"
 msgstr ""
 
@@ -63,6 +66,9 @@ msgstr "Standard-Branch im Git-Repository"
 msgid "Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata"
 msgstr "Standard-Metadaten-Exportmodus, Aktualisieren, rendert Metadaten neu, behält vorhandene Metadaten bei, entfernt Exportvorlagen ohne Metadaten"
 
+msgid "Directory within Git repo containing the templates."
+msgstr ""
+
 msgid "Dirname"
 msgstr "Dirname"
 
@@ -78,9 +84,24 @@ msgstr "Filter"
 msgid "Force import"
 msgstr "Import erzwingen"
 
+msgid "Global default HTTP proxy"
+msgstr ""
+
+msgid "HTTP proxy"
+msgstr ""
+
+msgid "HTTP proxy policy"
+msgstr ""
+
+msgid "HTTP proxy policy for template sync. If you choose 'selected', provide the `http_proxy_id` parameter."
+msgstr ""
+
 msgid "How to handle lock for imported templates?"
 msgstr ""
 
+msgid "ID of an HTTP proxy to use for template sync. Use this parameter together with `'http_proxy_policy':'selected'`"
+msgstr ""
+
 msgid "Import"
 msgstr "Importieren"
 
@@ -96,6 +117,9 @@ msgstr "Export initiieren"
 msgid "Initiate Import"
 msgstr "Import einleiten"
 
+msgid "Invalid repo format, must start with one of: "
+msgstr ""
+
 msgid "Keep"
 msgstr "Behalten"
 
@@ -132,6 +156,9 @@ msgstr "Nie"
 msgid "New"
 msgstr "Neu"
 
+msgid "No HTTP proxy"
+msgstr ""
+
 msgid "Override the default repo from settings."
 msgstr "Überschreiben Sie das Standard-Repository aus den Einstellungen."
 
@@ -159,6 +186,12 @@ msgstr "Entfernen"
 msgid "Repo"
 msgstr "Repository"
 
+msgid "Select an HTTP proxy to use for template sync. You can add HTTP proxies on the Infrastructure > HTTP proxies page."
+msgstr ""
+
+msgid "Should an HTTP proxy be used for template sync? If you select Custom HTTP proxy, you will be prompted to select one."
+msgstr ""
+
 msgid "Should importing overwrite locked templates?"
 msgstr "Sollen beim Importieren gesperrte Vorlagen überschrieben werden?"
 
@@ -177,9 +210,6 @@ msgstr ""
 msgid "Template Sync"
 msgstr ""
 
-msgid "The directory within Git repo containing the templates"
-msgstr "Das Verzeichnis im Git-Repository, das die Vorlagen enthält"
-
 msgid "The directory within the Git repo containing the templates"
 msgstr "Das Verzeichnis im Git-Repository, das die Vorlagen enthält"