Merge pull request #156 from crazy-max/prerelease-raw-pep440

fix: handle raw statement for pep440 pre-release

README.md

@@ -404,12 +404,13 @@ attribute.
 | `v1.2.3`           | `v{{major}}`                                             | `v1`                 |
 | `v1.2.3`           | `{{minor}}`                                              | `2`                  |
 | `v1.2.3`           | `{{patch}}`                                              | `3`                  |
-| `v2.0.8-beta.67`   | `{{raw}}`                                                | `2.0.8-beta.67`*     |
+| `v2.0.8-beta.67`   | `{{raw}}`                                                | `v2.0.8-beta.67`     |
 | `v2.0.8-beta.67`   | `{{version}}`                                            | `2.0.8-beta.67`      |
 | `v2.0.8-beta.67`   | `{{major}}.{{minor}}`                                    | `2.0.8-beta.67`*     |
 
-> *Pre-release (rc, beta, alpha) will only extend `{{version}}` as tag because they are updated frequently,
-> and contain many breaking changes that are (by the author's design) not yet fit for public consumption.
+> *Pre-release (rc, beta, alpha) will only extend `{{version}}` (or `{{raw}}` if specified) as tag
+> because they are updated frequently, and contain many breaking changes that are (by the author's design)
+> not yet fit for public consumption.
 
 Extended attributes and default values:
 
@@ -446,15 +447,16 @@ custom value through `value` attribute.
 | `v1.2.3`           | `{{version}}`                                            | `1.2.3`              |
 | `1.2.3`            | `{{major}}.{{minor}}`                                    | `1.2`                |
 | `1.2.3`            | `v{{major}}`                                             | `v1`                 |
-| `1.2.3rc2`         | `{{raw}}`                                                | `1.2.3rc2`*          |
+| `v1.2.3rc2`        | `{{raw}}`                                                | `v1.2.3rc2`          |
 | `1.2.3rc2`         | `{{version}}`                                            | `1.2.3rc2`           |
 | `1.2.3rc2`         | `{{major}}.{{minor}}`                                    | `1.2.3rc2`*          |
 | `1.2.3post1`       | `{{major}}.{{minor}}`                                    | `1.2.3.post1`*       |
 | `1.2.3beta2`       | `{{major}}.{{minor}}`                                    | `1.2.3b2`*           |
 | `1.0dev4`          | `{{major}}.{{minor}}`                                    | `1.0.dev4`*          |
 
-> *dev/pre/post release will only extend `{{version}}` as tag because they are updated frequently,
-> and contain many breaking changes that are (by the author's design) not yet fit for public consumption.
+> *dev/pre/post release will only extend `{{version}}` (or `{{raw}}` if specified) as tag
+> because they are updated frequently, and contain many breaking changes that are (by the author's design)
+> not yet fit for public consumption.
 
 Extended attributes and default values:
 

__tests__/context.test.ts

@@ -16,63 +16,54 @@ describe('getInputList', () => {
   it('single line correctly', async () => {
     await setInput('foo', 'bar');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar']);
   });
 
   it('multiline correctly', async () => {
     setInput('foo', 'bar\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('empty lines correctly', async () => {
     setInput('foo', 'bar\n\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('comma correctly', async () => {
     setInput('foo', 'bar,baz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('empty result correctly', async () => {
     setInput('foo', 'bar,baz,');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('different new lines correctly', async () => {
     setInput('foo', 'bar\r\nbaz');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz']);
   });
 
   it('different new lines and comma correctly', async () => {
     setInput('foo', 'bar\r\nbaz,bat');
     const res = await context.getInputList('foo');
-    console.log(res);
     expect(res).toEqual(['bar', 'baz', 'bat']);
   });
 
   it('multiline and ignoring comma correctly', async () => {
     setInput('cache-from', 'user/app:cache\ntype=local,src=path/to/dir');
     const res = await context.getInputList('cache-from', true);
-    console.log(res);
     expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
   });
 
   it('different new lines and ignoring comma correctly', async () => {
     setInput('cache-from', 'user/app:cache\r\ntype=local,src=path/to/dir');
     const res = await context.getInputList('cache-from', true);
-    console.log(res);
     expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
   });
 
@@ -86,7 +77,6 @@ ccccccccc"
 FOO=bar`
     );
     const res = await context.getInputList('secrets', true);
-    console.log(res);
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa
@@ -110,7 +100,6 @@ bbbb
 ccc"`
     );
     const res = await context.getInputList('secrets', true);
-    console.log(res);
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa
@@ -134,7 +123,6 @@ ccccccccc
 FOO=bar`
     );
     const res = await context.getInputList('secrets', true);
-    console.log(res);
     expect(res).toEqual(['GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789', 'MYSECRET=aaaaaaaa', 'bbbbbbb', 'ccccccccc', 'FOO=bar']);
   });
 
@@ -148,7 +136,6 @@ ccccccccc"
 FOO=bar`
     );
     const res = await context.getInputList('secrets', true);
-    console.log(res);
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa

__tests__/fixtures/event_tag_v1.2.3rc2.env

@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/v1.2.3rc2
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action

__tests__/flavor.test.ts

@@ -168,7 +168,6 @@ describe('transform', () => {
   ])('given %p attributes ', async (inputs: string[], expected: Flavor, invalid: boolean) => {
     try {
       const flavor = Transform(inputs);
-      console.log(flavor);
       expect(flavor).toEqual(expected);
     } catch (err) {
       if (!invalid) {

__tests__/github.test.ts

@@ -8,7 +8,6 @@ jest.spyOn(github, 'repo').mockImplementation((): Promise<github.ReposGetRespons
 describe('repo', () => {
   it('returns GitHub repository', async () => {
     const repo = await github.repo(process.env.GITHUB_TOKEN || '');
-    console.log(repo);
     expect(repo.name).not.toBeNull();
   });
 });

__tests__/meta.test.ts

@@ -31,24 +31,33 @@ beforeEach(() => {
   });
 });
 
+describe('isRawStatement', () => {
+  // prettier-ignore
+  test.each([
+    ['{{ raw }}.{{ version }}', false],
+    ['{{ version }},{{raw }.', false],
+    ['{{ raw }}', true],
+    ['{{ raw}}', true],
+    ['{{raw}}', true],
+  ])('given %p pattern ', async (pattern: string, expected: boolean) => {
+    expect(Meta.isRawStatement(pattern)).toEqual(expected);
+  });
+});
+
 const tagsLabelsTest = async (name: string, envFile: string, inputs: Inputs, exVersion: Version, exTags: Array<string>, exLabels: Array<string>) => {
   process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile)));
   const context = github.context();
-  console.log(process.env, context);
 
   const repo = await github.repo(process.env.GITHUB_TOKEN || '');
   const meta = new Meta({...getInputs(), ...inputs}, context, repo);
 
   const version = meta.version;
-  console.log('version', version);
   expect(version).toEqual(exVersion);
 
   const tags = meta.getTags();
-  console.log('tags', tags);
   expect(tags).toEqual(exTags);
 
   const labels = meta.getLabels();
-  console.log('labels', labels);
   expect(labels).toEqual(exLabels);
 };
 
@@ -1662,6 +1671,67 @@ describe('tag', () => {
         "org.opencontainers.image.licenses=MIT"
       ]
     ],
+    [
+      'tag31',
+      'event_tag_v2.0.8-beta.67.env',
+      {
+        images: ['org/app', 'ghcr.io/user/app'],
+        tags: [
+          `type=semver,pattern={{raw}}`
+        ]
+      } as Inputs,
+      {
+        main: 'v2.0.8-beta.67',
+        partial: [],
+        latest: false
+      } as Version,
+      [
+        'org/app:v2.0.8-beta.67',
+        'ghcr.io/user/app:v2.0.8-beta.67'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=v2.0.8-beta.67",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
+    [
+      'tag32',
+      'event_tag_v1.2.3rc2.env',
+      {
+        images: ['org/app', 'ghcr.io/user/app'],
+        tags: [
+          `type=pep440,pattern={{raw}}`,
+          `type=pep440,pattern={{major}}.{{minor}}`
+        ]
+      } as Inputs,
+      {
+        main: 'v1.2.3rc2',
+        partial: ['1.2.3rc2'],
+        latest: false
+      } as Version,
+      [
+        'org/app:v1.2.3rc2',
+        'org/app:1.2.3rc2',
+        'ghcr.io/user/app:v1.2.3rc2',
+        'ghcr.io/user/app:1.2.3rc2'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=v1.2.3rc2",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
   ])('given %p with %p event', tagsLabelsTest);
 });
 
@@ -3152,13 +3222,11 @@ describe('json', () => {
   ])('given %p with %p event', async (name: string, envFile: string, inputs: Inputs, exJSON: {}) => {
     process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile)));
     const context = github.context();
-    console.log(process.env, context);
 
     const repo = await github.repo(process.env.GITHUB_TOKEN || '');
     const meta = new Meta({...getInputs(), ...inputs}, context, repo);
 
     const jsonOutput = meta.getJSON();
-    console.log('json', jsonOutput);
     expect(jsonOutput).toEqual(exJSON);
   });
 });
@@ -3459,13 +3527,11 @@ describe('bake', () => {
   ])('given %p with %p event', async (name: string, envFile: string, inputs: Inputs, exBakeDefinition: {}) => {
     process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile)));
     const context = github.context();
-    console.log(process.env, context);
 
     const repo = await github.repo(process.env.GITHUB_TOKEN || '');
     const meta = new Meta({...getInputs(), ...inputs}, context, repo);
 
     const bakeFile = meta.getBakeFile();
-    console.log('bakeFile', bakeFile, fs.readFileSync(bakeFile, 'utf8'));
     expect(JSON.parse(fs.readFileSync(bakeFile, 'utf8'))).toEqual(exBakeDefinition);
   });
 });

__tests__/tag.test.ts

@@ -99,7 +99,6 @@ describe('transform', () => {
   ])('given %p', async (l: string[], expected: Tag[], invalid: boolean) => {
     try {
       const tags = Transform(l);
-      console.log(tags);
       expect(tags).toEqual(expected);
     } catch (err) {
       if (!invalid) {
@@ -429,7 +428,6 @@ describe('parse', () => {
   ])('given %p event ', async (s: string, expected: Tag, invalid: boolean) => {
     try {
       const tag = Parse(s);
-      console.log(tag);
       expect(tag).toEqual(expected);
     } catch (err) {
       if (!invalid) {

dist/index.js

@@ -526,8 +526,13 @@ class Meta {
             includePrerelease: true
         });
         if (semver.prerelease(vraw)) {
+            if (Meta.isRawStatement(tag.attrs['pattern'])) {
+                vraw = this.setValue(handlebars.compile(tag.attrs['pattern'])(sver), tag);
+            }
+            else {
                 vraw = this.setValue(handlebars.compile('{{version}}')(sver), tag);
             }
+        }
         else {
             vraw = this.setValue(handlebars.compile(tag.attrs['pattern'])(sver), tag);
             latest = true;
@@ -552,8 +557,13 @@ class Meta {
         let latest = false;
         const pver = pep440.explain(vraw);
         if (pver.is_prerelease || pver.is_postrelease || pver.is_devrelease) {
+            if (Meta.isRawStatement(tag.attrs['pattern'])) {
+                vraw = this.setValue(vraw, tag);
+            }
+            else {
                 vraw = this.setValue(pep440.clean(vraw), tag);
             }
+        }
         else {
             vraw = this.setValue(handlebars.compile(tag.attrs['pattern'])({
                 raw: function () {
@@ -671,6 +681,18 @@ class Meta {
         }
         return version;
     }
+    static isRawStatement(pattern) {
+        try {
+            const hp = handlebars.parseWithoutProcessing(pattern);
+            if (hp.body.length == 1 && hp.body[0].type == 'MustacheStatement') {
+                return hp.body[0]['path']['parts'].length == 1 && hp.body[0]['path']['parts'][0] == 'raw';
+            }
+        }
+        catch (err) {
+            return false;
+        }
+        return false;
+    }
     setValue(val, tag) {
         if (tag.attrs.hasOwnProperty('prefix')) {
             val = `${this.setGlobalExp(tag.attrs['prefix'])}${val}`;

src/meta.ts

@@ -143,7 +143,11 @@ export class Meta {
       includePrerelease: true
     });
     if (semver.prerelease(vraw)) {
+      if (Meta.isRawStatement(tag.attrs['pattern'])) {
+        vraw = this.setValue(handlebars.compile(tag.attrs['pattern'])(sver), tag);
+      } else {
         vraw = this.setValue(handlebars.compile('{{version}}')(sver), tag);
+      }
     } else {
       vraw = this.setValue(handlebars.compile(tag.attrs['pattern'])(sver), tag);
       latest = true;
@@ -171,7 +175,11 @@ export class Meta {
     let latest: boolean = false;
     const pver = pep440.explain(vraw);
     if (pver.is_prerelease || pver.is_postrelease || pver.is_devrelease) {
+      if (Meta.isRawStatement(tag.attrs['pattern'])) {
+        vraw = this.setValue(vraw, tag);
+      } else {
         vraw = this.setValue(pep440.clean(vraw), tag);
+      }
     } else {
       vraw = this.setValue(
         handlebars.compile(tag.attrs['pattern'])({
@@ -307,6 +315,18 @@ export class Meta {
     return version;
   }
 
+  public static isRawStatement(pattern: string): boolean {
+    try {
+      const hp = handlebars.parseWithoutProcessing(pattern);
+      if (hp.body.length == 1 && hp.body[0].type == 'MustacheStatement') {
+        return hp.body[0]['path']['parts'].length == 1 && hp.body[0]['path']['parts'][0] == 'raw';
+      }
+    } catch (err) {
+      return false;
+    }
+    return false;
+  }
+
   private setValue(val: string, tag: tcl.Tag): string {
     if (tag.attrs.hasOwnProperty('prefix')) {
       val = `${this.setGlobalExp(tag.attrs['prefix'])}${val}`;