Merge pull request #273 from travis-ci/bfsy-304-am

[BFSY-304] Allow to use commit_message as a template for import source
travis-ci · Apr 29, 2024 · 550f73b · 550f73b
2 parents dca14e6 + 65d90f1
commit 550f73b
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 8 deletions.
diff --git a/lib/travis/yml/configs/config/file.rb b/lib/travis/yml/configs/config/file.rb
@@ -1,3 +1,4 @@
+require 'cgi'
 require 'travis/yml/configs/content'
 require 'travis/yml/configs/config/base'
 
@@ -10,6 +11,8 @@ class File < Obj.new(:ctx, :parent, :vcs_id, :provider, :defn)
 
           attr_reader :path, :ref, :raw
 
+          PERMITTED_KEYS = %w(commit_message).freeze
+
           def initialize(ctx, parent, vcs_id, provider, defn)
             defn = stringify(defn)
             @vcs_id = vcs_id
@@ -101,10 +104,16 @@ def expand(source)
             end
 
             def fetch
-              Content.new(repo, "#{path_suffix}#{path}", ref).content
+              Content.new(repo, interpolated_path, ref).content
             rescue FileNotFound => e
               required? ? raise : nil
             end
+
+            def interpolated_path
+              new_path = path.gsub(/%{(#{PERMITTED_KEYS.join('|')}|.*)}/) { CGI.escape(ctx.data[$1.to_sym]) }
+
+              "#{path_suffix}#{new_path}"
+            end
         end
       end
     end

diff --git a/lib/travis/yml/schema/def/imports.rb b/lib/travis/yml/schema/def/imports.rb
@@ -33,13 +33,26 @@ def define
             normal
             prefix :source
 
-            map :source, to: :str, summary: 'The source to import build config from', eg: './import.yml@v1'
+            map :source, to: :import_template, summary: 'The source to import build config from', eg: './import.yml@v1'
             map :mode,   to: :str, values: ['merge', 'deep_merge', 'deep_merge_append', 'deep_merge_prepend'], summary: 'How to merge the imported config into the target config (defaults to deep_merge_append)'
             map :if,     to: :condition
 
             export
           end
         end
+
+        class ImportTemplate < Type::Str
+          registry :import
+          register :import_template
+
+          def define
+            vars *%w(
+              commit_message
+            )
+
+            export
+          end
+        end
       end
     end
   end

diff --git a/schema.json b/schema.json
@@ -811,7 +811,7 @@
             "type": "object",
             "properties": {
               "source": {
-                "type": "string",
+                "$ref": "#/definitions/import/import_template",
                 "summary": "The source to import build config from",
                 "example": "./import.yml@v1"
               },
@@ -836,7 +836,7 @@
             }
           },
           {
-            "type": "string",
+            "$ref": "#/definitions/import/import_template",
             "example": "./import.yml@v1"
           }
         ],
@@ -2451,6 +2451,16 @@
         "normal": true
       }
     },
+    "import": {
+      "import_template": {
+        "$id": "import_template",
+        "title": "Import Template",
+        "type": "string",
+        "vars": [
+          "commit_message"
+        ]
+      }
+    },
     "addon": {
       "apt": {
         "$id": "apt",

diff --git a/spec/travis/yml/configs/import_spec.rb b/spec/travis/yml/configs/import_spec.rb
@@ -215,6 +215,28 @@ def self.imports(sources)
     it { expect(subject.map(&:merge_modes)).to eq [{ lft: :deep_merge_append }, { lft: 'merge' }, { lft: 'deep_merge' }] }
   end
 
+  describe 'imports with template path' do
+    let(:data) { { commit_message: 'one' } }
+
+    let(:travis_yml) do
+      <<~yml
+        import:
+          - source: "%{commit_message}/one.yml"
+            mode: merge
+      yml
+    end
+
+    let(:one_yml) do
+      <<~yml
+        import:
+          - source: "%{commit_message}/two.yml"
+            mode: deep_merge
+      yml
+    end
+
+    it { expect(subject.map(&:merge_modes)).to eq [{ lft: :deep_merge_append }, { lft: 'merge' }, { lft: 'deep_merge' }] }
+  end
+
   describe 'conditional imports' do
     let(:travis_yml) do
       <<~yml

diff --git a/spec/travis/yml/schema/def/imports_spec.rb b/spec/travis/yml/schema/def/imports_spec.rb
@@ -40,9 +40,9 @@
             type: :object,
             properties: {
               source: {
-                type: :string,
-                summary: 'The source to import build config from',
-                example: './import.yml@v1'
+                '$ref': '#/definitions/import/import_template',
+                example:'./import.yml@v1',
+                summary: 'The source to import build config from'
               },
               mode: {
                 type: :string,
@@ -60,7 +60,7 @@
             },
           },
           {
-            type: :string,
+            '$ref': '#/definitions/import/import_template',
             example: './import.yml@v1'
           }
         ]