refactor!: add test runner (#28)

this may break some users because the S3CMD_CONFIG environment variable
is now used to place and use the s3cmd config file from
${process.env.RUNNER_TEMP}/s3cmd.conf. Users that read this file
directly in their workflow need to adjust the path they are using.

Signed-off-by: Nico Braun <[email protected]>

Author: bluebrown

.github/workflows/validate.yml

@@ -1,3 +1,4 @@
+---
 name: validate
 
 on:
@@ -6,23 +7,31 @@ on:
     branches: ["main"]
   pull_request:
     types:
-      - opened
-      - synchronize
-      - reopened
-      - ready_for_review
-  
+    - opened
+    - synchronize
+    - reopened
+    - ready_for_review
+
 jobs:
   use_s3cmd:
     runs-on: ubuntu-latest
     name: Validate Project
     steps:
-      - uses: actions/checkout@v2
-      - run: |
-          npm i
-          mv dist/index.js old
-          npm run build
-          if cmp --silent -- old dist/index.js; then
-            exit 0
-          else
-            exit 1
-          fi
+    - uses: actions/checkout@v2
+
+    - name: install dependencies
+      run: npm ci
+
+    - name: verify dist is up to date
+      run: |
+        mv dist/index.js old
+        npm run build
+        if cmp --silent -- old dist/index.js; then
+          exit 0
+        else
+          exit 1
+        fi
+
+    - name: Run Tests
+      run: npm run test
+

README.md

@@ -4,7 +4,8 @@ This action is a simple wrapper for [S3cmd](https://github.com/s3tools/s3cmd).
 
 ## Supported Providers
 
-Currently the below providers are supported, but it could be used with other providers too when using additional flags.
+Currently the below providers are supported, but it could be used with
+other providers too when using additional flags.
 
 - AWS
 - DigitalOcean
@@ -22,9 +23,11 @@ Currently the below providers are supported, but it could be used with other pro
 
 ### `provider`
 
-**Not Required** The s3 provider to use. Defaults to `linode`. 
+**Not Required** The s3 provider to use. Defaults to `linode`.
 
-Supported values: `aws`, `digitalocean`, `linode`, `scaleway`, `cloudflare`, `vultr`, `clevercloud`, `hcloud`, `synologyc2`, `wasabi`, `yandex`.
+Supported values: `aws`, `digitalocean`, `linode`, `scaleway`,
+`cloudflare`, `vultr`, `clevercloud`, `hcloud`, `synologyc2`, `wasabi`,
+`yandex`.
 
 ### `secret_key`
 
@@ -40,7 +43,8 @@ Supported values: `aws`, `digitalocean`, `linode`, `scaleway`, `cloudflare`, `vu
 
 ### `account_id`
 
-**Not Required** Cloudflare account ID. Only required when using Cloudflare R2.
+**Not Required** Cloudflare account ID. Only required when using
+Cloudflare R2.
 
 ## Example usage
 
@@ -62,13 +66,17 @@ Supported values: `aws`, `digitalocean`, `linode`, `scaleway`, `cloudflare`, `vu
 
 ### Note
 
-The region only matters when creating a new bucket with `mb`. In that case a different region apart from the default region can be provided ad hoc.
+The region only matters when creating a new bucket with `mb`. In that
+case a different region apart from the default region can be provided ad
+hoc.
 
 ```console
 s3cmd mb --region ap-south-1 s3://my-bucket
 ```
 
-For linode object storage this wont work though. The region must always be set to US. If you want to change the region on the fly you can still do ith with the below command.
+For linode object storage this wont work though. The region must always
+be set to US. If you want to change the region on the fly you can still
+do ith with the below command.
 
 ```console
 s3cmd mb --host ap-south-1.linodeobjects.com  s3://my-bucket

action.test.js

@@ -0,0 +1,30 @@
+const assert = require("node:assert");
+const { readFileSync } = require("node:fs");
+const { join } = require("node:path");
+const { tests } = require("./src/providers");
+
+const { RunOptions, RunTarget } = require("github-action-ts-run-api");
+
+(async () => {
+  for (const [provider, { giveInputs, wantLines }] of Object.entries(tests)) {
+    console.log(`\n---\nTesting provider: ${provider}`);
+
+    const target = RunTarget.mainJs("action.yml");
+    const options = RunOptions.create()
+      .setFakeFsOptions({ rmFakedTempDirAfterRun: false })
+      .setInputs({ ...giveInputs, provider });
+
+    const res = await target.run(options);
+    try {
+      assert.strictEqual(res.exitCode, 0);
+
+      const b = readFileSync(join(res.tempDirPath, "s3cmd.conf"));
+      const data = b.toString();
+      for (const line of wantLines) {
+        assert.ok(data.includes(line), `${provider}: missing line: ${line}`);
+      }
+    } finally {
+      res.cleanUpFakedDirs();
+    }
+  }
+})();

action.yml

@@ -1,9 +1,14 @@
+---
 name: "Use S3cmd"
 description: "Use S3cmd cli to interact with s3 object storage"
 branding:
   icon: "award"
   color: "green"
 inputs:
+  s3cmd_version:
+    description: "s3cmd version to use (default: 2.4.0)"
+    default: "2.4.0"
+    required: false
   provider:
     description: "config provider to make it easier to use the cli as action"
     default: "linode"