Add optional gzip flag (#15)

Author: omrihq

README.md

@@ -108,6 +108,14 @@ The files will be uploaded to `gs://bucket-name/folder/file1`,`gs://bucket-name/
 
   In the above example, the file will be uploaded to gs://bucket-name/prefix/file
 
+- `gzip`: (Optional) Upload file(s) with gzip content encoding, defaults to true.
+
+  ```yaml
+  gzip: false
+  ```
+
+  In the above example, the file(s) will be uploaded without `gzip` content-encoding
+
 - `credentials`: (Optional) [Google Service Account JSON][sa] credentials as JSON or base64 encoded string,
   typically sourced from a [GitHub Secret][gh-secret]. If unspecified, other
   authentication methods are attempted. See [Authorization](#Authorization) below.

action.yml

@@ -20,6 +20,10 @@ inputs:
       GCS bucket name of form <bucketname> or with an optional prefix
       of form <bucketname>/<prefix>
     required: true
+  gzip:
+    description: |-
+      Upload file(s) with gzip content encoding, defaults to true.
+    required: false
 
 runs:
   using: "node12"

src/client.ts

@@ -60,7 +60,11 @@ export class Client {
    * @param prefix Optional prefix when uploading to GCS.
    * @returns List of uploaded file(s).
    */
-  async upload(destination: string, path: string): Promise<UploadResponse[]> {
+  async upload(
+    destination: string,
+    path: string,
+    gzip: boolean,
+  ): Promise<UploadResponse[]> {
     let bucketName = destination;
     let prefix = '';
     // If destination of the form my-bucket/subfolder get bucket and prefix.
@@ -73,12 +77,18 @@ export class Client {
     const stat = await fs.promises.stat(path);
     const uploader = new UploadHelper(this.storage);
     if (stat.isFile()) {
-      const uploadedFile = await uploader.uploadFile(bucketName, path, prefix);
+      const uploadedFile = await uploader.uploadFile(
+        bucketName,
+        path,
+        gzip,
+        prefix,
+      );
       return [uploadedFile];
     } else {
       const uploadedFiles = await uploader.uploadDirectory(
         bucketName,
         path,
+        gzip,
         prefix,
       );
       return uploadedFiles;

src/main.ts

@@ -21,9 +21,11 @@ async function run(): Promise<void> {
   try {
     const path = core.getInput('path', { required: true });
     const destination = core.getInput('destination', { required: true });
+    const gzip =
+      core.getInput('gzip', { required: false }) === 'false' ? false : true;
     const serviceAccountKey = core.getInput('credentials');
     const client = new Client({ credentials: serviceAccountKey });
-    const uploadResponses = await client.upload(destination, path);
+    const uploadResponses = await client.upload(destination, path, gzip);
 
     core.setOutput(
       'uploaded',

src/upload-helper.ts

@@ -46,13 +46,14 @@ export class UploadHelper {
   async uploadFile(
     bucketName: string,
     filename: string,
+    gzip: boolean,
     destination?: string,
   ): Promise<UploadResponse> {
     interface UploadOptions {
       gzip: boolean;
       destination?: string;
     }
-    const options: UploadOptions = { gzip: true };
+    const options: UploadOptions = { gzip };
     if (destination) {
       // If obj prefix is set, then extract filename and append to prefix.
       options.destination = `${destination}/${path.posix.basename(filename)}`;
@@ -76,6 +77,7 @@ export class UploadHelper {
   async uploadDirectory(
     bucketName: string,
     directoryPath: string,
+    gzip: boolean,
     prefix = '',
   ): Promise<UploadResponse[]> {
     const pathDirName = path.posix.dirname(directoryPath);
@@ -96,6 +98,7 @@ export class UploadHelper {
         const uploadResp = await this.uploadFile(
           bucketName,
           filePath,
+          gzip,
           destination,
         );
         return uploadResp;

tests/client.test.ts

@@ -51,11 +51,12 @@ describe('Unit Test Client', function() {
     const path = './tests/testdata/test1.txt';
     const bucketName = 'foo';
     const prefix = 'test-prefix';
-    await client.upload(`${bucketName}/${prefix}`, path);
+    await client.upload(`${bucketName}/${prefix}`, path, true);
     expect(uploadFileStub.calledOnce);
     expect(uploadFileStub.firstCall.args[0]).to.equal(bucketName);
     expect(uploadFileStub.firstCall.args[1]).to.equal(path);
-    expect(uploadFileStub.firstCall.args[2]).to.equal(prefix);
+    expect(uploadFileStub.firstCall.args[2]).to.equal(true);
+    expect(uploadFileStub.firstCall.args[3]).to.equal(prefix);
   });
 
   it('calls uploadDirectory', async function() {
@@ -66,10 +67,11 @@ describe('Unit Test Client', function() {
     const client = new Client();
     const path = './tests/testdata';
     const bucketName = 'foo';
-    await client.upload(bucketName, path);
+    await client.upload(bucketName, path, true);
     expect(uploadDirSpy.calledOnce);
     expect(uploadDirSpy.firstCall.args[0]).to.equal(bucketName);
     expect(uploadDirSpy.firstCall.args[1]).to.equal(path);
-    expect(uploadDirSpy.firstCall.args[2]).to.equal('');
+    expect(uploadDirSpy.firstCall.args[2]).to.equal(true);
+    expect(uploadDirSpy.firstCall.args[3]).to.equal('');
   });
 });

tests/upload-helper.int.test.ts

@@ -31,6 +31,7 @@ describe('Integration Upload Helper', function() {
     const uploadResponse = await uploader.uploadFile(
       testBucket,
       './tests/testdata/test1.txt',
+      true,
     );
     expect(uploadResponse[0].name).eql('test1.txt');
   });
@@ -44,6 +45,7 @@ describe('Integration Upload Helper', function() {
     const uploadResponse = await uploader.uploadFile(
       testBucket,
       './tests/testdata/test1.txt',
+      true,
       'testprefix',
     );
     expect(uploadResponse[0].name).eql('testprefix/test1.txt');
@@ -58,6 +60,7 @@ describe('Integration Upload Helper', function() {
     const uploadResponse = await uploader.uploadFile(
       testBucket,
       './tests/testdata/testfile',
+      true,
       'testprefix',
     );
     expect(uploadResponse[0].name).eql('testprefix/testfile');
@@ -72,6 +75,7 @@ describe('Integration Upload Helper', function() {
     const uploadResponse = await uploader.uploadFile(
       testBucket,
       './tests/testdata/🚀',
+      true,
       'testprefix',
     );
     expect(uploadResponse[0].name).eql('testprefix/🚀');

tests/upload-helper.test.ts

@@ -46,14 +46,19 @@ describe('Unit Test uploadFile', function() {
 
   it('uploads a single file', async function() {
     const uploader = new UploadHelper(new Storage());
-    await uploader.uploadFile(EXAMPLE_BUCKET, EXAMPLE_FILE);
+    await uploader.uploadFile(EXAMPLE_BUCKET, EXAMPLE_FILE, true);
     // Assert that upload method in storage library was called with right file.
     expect(this.uploadStub.firstCall.args[0]).eq(EXAMPLE_FILE);
   });
 
   it('uploads a single file with prefix', async function() {
     const uploader = new UploadHelper(new Storage());
-    await uploader.uploadFile(EXAMPLE_BUCKET, EXAMPLE_FILE, EXAMPLE_PREFIX);
+    await uploader.uploadFile(
+      EXAMPLE_BUCKET,
+      EXAMPLE_FILE,
+      true,
+      EXAMPLE_PREFIX,
+    );
     // Assert that upload method in storage library was called with right file
     // and right prefix.
     expect(this.uploadStub.firstCall.args[0]).eq(EXAMPLE_FILE);
@@ -83,7 +88,7 @@ describe('Unit Test uploadDir', function() {
 
   it('uploads a dir', async function() {
     const uploader = new UploadHelper(new Storage());
-    await uploader.uploadDirectory(EXAMPLE_BUCKET, EXAMPLE_DIR);
+    await uploader.uploadDirectory(EXAMPLE_BUCKET, EXAMPLE_DIR, true);
     // Assert that uploadFile was called for each file in directory.
     expect(this.uploadFileStub.callCount).eq(FILES_IN_DIR.length);
     // Capture filename arguments passed to uploadFile.
@@ -97,7 +102,12 @@ describe('Unit Test uploadDir', function() {
 
   it('uploads a dir with prefix', async function() {
     const uploader = new UploadHelper(new Storage());
-    await uploader.uploadDirectory(EXAMPLE_BUCKET, EXAMPLE_DIR, EXAMPLE_PREFIX);
+    await uploader.uploadDirectory(
+      EXAMPLE_BUCKET,
+      EXAMPLE_DIR,
+      true,
+      EXAMPLE_PREFIX,
+    );
     // Assert that uploadFile was called for each file in directory.
     expect(this.uploadFileStub.callCount).eq(FILES_IN_DIR.length);
     // Capture filename arguments passed to uploadFile.
@@ -107,7 +117,7 @@ describe('Unit Test uploadDir', function() {
     );
     // Capture destination arguments passed to uploadFile.
     const destinations = uploadFileCalls.map(
-      (uploadFileCall: sinon.SinonSpyCall) => uploadFileCall.args[2],
+      (uploadFileCall: sinon.SinonSpyCall) => uploadFileCall.args[3],
     );
     // Assert uploadDir called uploadFile with right files.
     expect(filenames).to.have.members(FILES_IN_DIR);