Merge pull request #21 from crazy-max/handle-aws-env

Handle AWS credentials

.github/workflows/ci.yml

@@ -117,3 +117,34 @@ jobs:
 #        if: always()
 #        run: |
 #          rm -f ${HOME}/.docker/config.json
+#
+#  ecr-aws-creds:
+#    runs-on: ${{ matrix.os }}
+#    strategy:
+#      fail-fast: false
+#      matrix:
+#        os:
+#          - ubuntu-20.04
+#          - ubuntu-18.04
+#          - ubuntu-16.04
+#    steps:
+#      -
+#        name: Checkout
+#        uses: actions/checkout@v2.3.1
+#      -
+#        name: Configure AWS Credentials
+#        uses: aws-actions/configure-aws-credentials@v1
+#        with:
+#          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+#          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+#          aws-region: ${{ secrets.AWS_REGION }}
+#      -
+#        name: Login to ECR
+#        uses: ./
+#        with:
+#          registry: ${{ secrets.AWS_ACCOUNT_NUMBER }}.dkr.ecr.${{ secrets.AWS_REGION }}.amazonaws.com
+#      -
+#        name: Clear
+#        if: always()
+#        run: |
+#          rm -f ${HOME}/.docker/config.json

README.md

@@ -213,6 +213,34 @@ jobs:
           password: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 ```
 
+You can also use the [Configure AWS Credentials](https://github.com/aws-actions/configure-aws-credentials) action in
+combination with this action:
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: master
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: <region>
+      -
+        name: Login to ECR
+        uses: docker/login-action@v1
+        with:
+          registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
+```
+
 > Replace `<aws-account-number>` and `<region>` with their respective values.
 
 ## Customizing

__tests__/context.test.ts

@@ -0,0 +1,11 @@
+import osm = require('os');
+
+import {getInputs} from '../src/context';
+
+test('with password and username getInputs does not throw error', async () => {
+  process.env['INPUT_USERNAME'] = 'dbowie';
+  process.env['INPUT_PASSWORD'] = 'groundcontrol';
+  expect(() => {
+    getInputs();
+  }).not.toThrowError();
+});

__tests__/docker.test.ts

@@ -0,0 +1,49 @@
+import {loginStandard, logout} from '../src/docker';
+
+import * as path from 'path';
+
+import * as exec from '@actions/exec';
+
+process.env['RUNNER_TEMP'] = path.join(__dirname, 'runner');
+
+test('loginStandard calls exec', async () => {
+  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'exec');
+  // don't let exec try to actually run the commands
+  execSpy.mockImplementation(() => {});
+
+  const username: string = 'dbowie';
+  const password: string = 'groundcontrol';
+  const registry: string = 'https://ghcr.io';
+
+  await loginStandard(registry, username, password);
+
+  expect(execSpy).toHaveBeenCalledWith(`docker`, ['login', '--password-stdin', '--username', username, registry], {
+    input: Buffer.from(password),
+    silent: true,
+    ignoreReturnCode: true,
+    listeners: expect.objectContaining({
+      stdout: expect.any(Function),
+      stderr: expect.any(Function)
+    })
+  });
+});
+
+test('logout calls exec', async () => {
+  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'exec');
+  // don't let exec try to actually run the commands
+  execSpy.mockImplementation(() => {});
+
+  const registry: string = 'https://ghcr.io';
+
+  await logout(registry);
+
+  expect(execSpy).toHaveBeenCalledWith(`docker`, ['logout', registry], {
+    silent: false,
+    ignoreReturnCode: true,
+    input: Buffer.from(''),
+    listeners: expect.objectContaining({
+      stdout: expect.any(Function),
+      stderr: expect.any(Function)
+    })
+  });
+});

__tests__/main.test.ts

@@ -0,0 +1,79 @@
+import osm = require('os');
+
+import {run} from '../src/main';
+import * as docker from '../src/docker';
+import * as stateHelper from '../src/state-helper';
+
+import * as core from '@actions/core';
+
+test('errors when not run on linux platform', async () => {
+  const platSpy = jest.spyOn(osm, 'platform');
+  platSpy.mockImplementation(() => 'netbsd');
+
+  const coreSpy: jest.SpyInstance = jest.spyOn(core, 'setFailed');
+
+  await run();
+
+  expect(coreSpy).toHaveBeenCalledWith('Only supported on linux platform');
+});
+
+test('errors without username and password', async () => {
+  const platSpy = jest.spyOn(osm, 'platform');
+  platSpy.mockImplementation(() => 'linux');
+
+  const coreSpy: jest.SpyInstance = jest.spyOn(core, 'setFailed');
+
+  await run();
+
+  expect(coreSpy).toHaveBeenCalledWith('Username and password required');
+});
+
+test('successful with username and password', async () => {
+  const platSpy = jest.spyOn(osm, 'platform');
+  platSpy.mockImplementation(() => 'linux');
+
+  const setRegistrySpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setRegistry');
+  const setLogoutSpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setLogout');
+  const dockerSpy: jest.SpyInstance = jest.spyOn(docker, 'login');
+  dockerSpy.mockImplementation(() => {});
+
+  const username: string = 'dbowie';
+  process.env[`INPUT_USERNAME`] = username;
+
+  const password: string = 'groundcontrol';
+  process.env[`INPUT_PASSWORD`] = password;
+
+  await run();
+
+  expect(setRegistrySpy).toHaveBeenCalledWith('');
+  expect(setLogoutSpy).toHaveBeenCalledWith('');
+  expect(dockerSpy).toHaveBeenCalledWith('', username, password);
+});
+
+test('calls docker login', async () => {
+  const platSpy = jest.spyOn(osm, 'platform');
+  platSpy.mockImplementation(() => 'linux');
+
+  const setRegistrySpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setRegistry');
+  const setLogoutSpy: jest.SpyInstance = jest.spyOn(stateHelper, 'setLogout');
+  const dockerSpy: jest.SpyInstance = jest.spyOn(docker, 'login');
+  dockerSpy.mockImplementation(() => {});
+
+  const username: string = 'dbowie';
+  process.env[`INPUT_USERNAME`] = username;
+
+  const password: string = 'groundcontrol';
+  process.env[`INPUT_PASSWORD`] = password;
+
+  const registry: string = 'ghcr.io';
+  process.env[`INPUT_REGISTRY`] = registry;
+
+  const logout: string = 'true';
+  process.env['INPUT_LOGOUT'] = logout;
+
+  await run();
+
+  expect(setRegistrySpy).toHaveBeenCalledWith(registry);
+  expect(setLogoutSpy).toHaveBeenCalledWith(logout);
+  expect(dockerSpy).toHaveBeenCalledWith(registry, username, password);
+});

action.yml

@@ -15,7 +15,7 @@ inputs:
     required: false
   password:
     description: 'Password or personal access token used to log against the Docker registry'
-    required: true
+    required: false
   logout:
     description: 'Log out from the Docker registry at the end of a job'
     default: 'true'

dist/index.js

@@ -496,6 +496,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
 const os = __importStar(__webpack_require__(87));
 const core = __importStar(__webpack_require__(186));
 const context_1 = __webpack_require__(842);
@@ -505,19 +506,19 @@ function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             if (os.platform() !== 'linux') {
-                core.setFailed('Only supported on linux platform');
-                return;
+                throw new Error('Only supported on linux platform');
             }
-            let inputs = yield context_1.getInputs();
-            stateHelper.setRegistry(inputs.registry);
-            stateHelper.setLogout(inputs.logout);
-            yield docker.login(inputs.registry, inputs.username, inputs.password);
+            const { registry, username, password, logout } = context_1.getInputs();
+            stateHelper.setRegistry(registry);
+            stateHelper.setLogout(logout);
+            yield docker.login(registry, username, password);
         }
         catch (error) {
             core.setFailed(error.message);
         }
     });
 }
+exports.run = run;
 function logout() {
     return __awaiter(this, void 0, void 0, function* () {
         if (!stateHelper.logout) {
@@ -1261,6 +1262,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __webpack_require__(351);
+const file_command_1 = __webpack_require__(717);
+const utils_1 = __webpack_require__(278);
 const os = __importStar(__webpack_require__(87));
 const path = __importStar(__webpack_require__(622));
 /**
@@ -1287,9 +1290,17 @@ var ExitCode;
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function exportVariable(name, val) {
-    const convertedVal = command_1.toCommandValue(val);
+    const convertedVal = utils_1.toCommandValue(val);
     process.env[name] = convertedVal;
-    command_1.issueCommand('set-env', { name }, convertedVal);
+    const filePath = process.env['GITHUB_ENV'] || '';
+    if (filePath) {
+        const delimiter = '_GitHubActionsFileCommandDelimeter_';
+        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
+        file_command_1.issueCommand('ENV', commandValue);
+    }
+    else {
+        command_1.issueCommand('set-env', { name }, convertedVal);
+    }
 }
 exports.exportVariable = exportVariable;
 /**
@@ -1305,7 +1316,13 @@ exports.setSecret = setSecret;
  * @param inputPath
  */
 function addPath(inputPath) {
-    command_1.issueCommand('add-path', {}, inputPath);
+    const filePath = process.env['GITHUB_PATH'] || '';
+    if (filePath) {
+        file_command_1.issueCommand('PATH', inputPath);
+    }
+    else {
+        command_1.issueCommand('add-path', {}, inputPath);
+    }
     process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`;
 }
 exports.addPath = addPath;
@@ -1475,6 +1492,32 @@ const lt = (a, b, loose) => compare(a, b, loose) < 0
 module.exports = lt
 
 
+/***/ }),
+
+/***/ 278:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Sanitizes an input into a string so it can be passed into issueCommand safely
+ * @param input input to sanitize into a string
+ */
+function toCommandValue(input) {
+    if (input === null || input === undefined) {
+        return '';
+    }
+    else if (typeof input === 'string' || input instanceof String) {
+        return input;
+    }
+    return JSON.stringify(input);
+}
+exports.toCommandValue = toCommandValue;
+//# sourceMappingURL=utils.js.map
+
 /***/ }),
 
 /***/ 293:
@@ -1568,6 +1611,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(278);
 /**
  * Commands
  *
@@ -1621,28 +1665,14 @@ class Command {
         return cmdStr;
     }
 }
-/**
- * Sanitizes an input into a string so it can be passed into issueCommand safely
- * @param input input to sanitize into a string
- */
-function toCommandValue(input) {
-    if (input === null || input === undefined) {
-        return '';
-    }
-    else if (typeof input === 'string' || input instanceof String) {
-        return input;
-    }
-    return JSON.stringify(input);
-}
-exports.toCommandValue = toCommandValue;
 function escapeData(s) {
-    return toCommandValue(s)
+    return utils_1.toCommandValue(s)
         .replace(/%/g, '%25')
         .replace(/\r/g, '%0D')
         .replace(/\n/g, '%0A');
 }
 function escapeProperty(s) {
-    return toCommandValue(s)
+    return utils_1.toCommandValue(s)
         .replace(/%/g, '%25')
         .replace(/\r/g, '%0D')
         .replace(/\n/g, '%0A')
@@ -2845,6 +2875,42 @@ const toComparators = (range, options) =>
 module.exports = toComparators
 
 
+/***/ }),
+
+/***/ 717:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+// For internal use, subject to change.
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const fs = __importStar(__webpack_require__(747));
+const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(278);
+function issueCommand(command, message) {
+    const filePath = process.env[`GITHUB_${command}`];
+    if (!filePath) {
+        throw new Error(`Unable to find environment variable for file command ${command}`);
+    }
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`Missing file at path: ${filePath}`);
+    }
+    fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, {
+        encoding: 'utf8'
+    });
+}
+exports.issueCommand = issueCommand;
+//# sourceMappingURL=file-command.js.map
+
 /***/ }),
 
 /***/ 741:
@@ -2996,10 +3062,11 @@ function logout(registry) {
 exports.logout = logout;
 function loginStandard(registry, username, password) {
     return __awaiter(this, void 0, void 0, function* () {
-        let loginArgs = ['login', '--password-stdin'];
-        if (username) {
-            loginArgs.push('--username', username);
+        if (!username || !password) {
+            throw new Error('Username and password required');
         }
+        let loginArgs = ['login', '--password-stdin'];
+        loginArgs.push('--username', username);
         loginArgs.push(registry);
         if (registry) {
             core.info(`🔑 Logging into ${registry}...`);
@@ -3022,8 +3089,8 @@ function loginECR(registry, username, password) {
         const cliVersion = yield aws.getCLIVersion();
         const region = yield aws.getRegion(registry);
         core.info(`💡 AWS ECR detected with ${region} region`);
-        process.env.AWS_ACCESS_KEY_ID = username;
-        process.env.AWS_SECRET_ACCESS_KEY = password;
+        process.env.AWS_ACCESS_KEY_ID = username || process.env.AWS_ACCESS_KEY_ID;
+        process.env.AWS_SECRET_ACCESS_KEY = password || process.env.AWS_SECRET_ACCESS_KEY;
         core.info(`⬇️ Retrieving docker login command through AWS CLI ${cliVersion} (${cliPath})...`);
         const loginCmd = yield aws.getDockerLoginCmd(cliVersion, registry, region);
         core.info(`🔑 Logging into ${registry}...`);
@@ -3575,27 +3642,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInputs = void 0;
 const core = __importStar(__webpack_require__(186));
 function getInputs() {
-    return __awaiter(this, void 0, void 0, function* () {
-        return {
-            registry: core.getInput('registry'),
-            username: core.getInput('username'),
-            password: core.getInput('password', { required: true }),
-            logout: core.getInput('logout')
-        };
-    });
+    return {
+        registry: core.getInput('registry'),
+        username: core.getInput('username'),
+        password: core.getInput('password'),
+        logout: core.getInput('logout')
+    };
 }
 exports.getInputs = getInputs;
 //# sourceMappingURL=context.js.map

package.json

@@ -27,7 +27,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.5",
+    "@actions/core": "^1.2.6",
     "@actions/exec": "^1.0.4",
     "@actions/io": "^1.0.2",
     "semver": "^7.3.2"

src/context.ts

@@ -7,11 +7,11 @@ export interface Inputs {
   logout: string;
 }
 
-export async function getInputs(): Promise<Inputs> {
+export function getInputs(): Inputs {
   return {
     registry: core.getInput('registry'),
     username: core.getInput('username'),
-    password: core.getInput('password', {required: true}),
+    password: core.getInput('password'),
     logout: core.getInput('logout')
   };
 }

src/docker.ts

@@ -19,10 +19,12 @@ export async function logout(registry: string): Promise<void> {
 }
 
 export async function loginStandard(registry: string, username: string, password: string): Promise<void> {
-  let loginArgs: Array<string> = ['login', '--password-stdin'];
-  if (username) {
-    loginArgs.push('--username', username);
+  if (!username || !password) {
+    throw new Error('Username and password required');
   }
+
+  let loginArgs: Array<string> = ['login', '--password-stdin'];
+  loginArgs.push('--username', username);
   loginArgs.push(registry);
 
   if (registry) {
@@ -44,8 +46,8 @@ export async function loginECR(registry: string, username: string, password: str
   const region = await aws.getRegion(registry);
   core.info(`💡 AWS ECR detected with ${region} region`);
 
-  process.env.AWS_ACCESS_KEY_ID = username;
-  process.env.AWS_SECRET_ACCESS_KEY = password;
+  process.env.AWS_ACCESS_KEY_ID = username || process.env.AWS_ACCESS_KEY_ID;
+  process.env.AWS_SECRET_ACCESS_KEY = password || process.env.AWS_SECRET_ACCESS_KEY;
 
   core.info(`⬇️ Retrieving docker login command through AWS CLI ${cliVersion} (${cliPath})...`);
   const loginCmd = await aws.getDockerLoginCmd(cliVersion, registry, region);

src/main.ts

@@ -4,17 +4,16 @@ import {getInputs, Inputs} from './context';
 import * as docker from './docker';
 import * as stateHelper from './state-helper';
 
-async function run(): Promise<void> {
+export async function run(): Promise<void> {
   try {
     if (os.platform() !== 'linux') {
-      core.setFailed('Only supported on linux platform');
-      return;
+      throw new Error('Only supported on linux platform');
     }
 
-    let inputs: Inputs = await getInputs();
-    stateHelper.setRegistry(inputs.registry);
-    stateHelper.setLogout(inputs.logout);
-    await docker.login(inputs.registry, inputs.username, inputs.password);
+    const {registry, username, password, logout} = getInputs();
+    stateHelper.setRegistry(registry);
+    stateHelper.setLogout(logout);
+    await docker.login(registry, username, password);
   } catch (error) {
     core.setFailed(error.message);
   }

yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@actions/core@^1.2.5":
-  version "1.2.5"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.5.tgz#fa57bf8c07a38191e243beb9ea9d8368c1cb02c8"
-  integrity sha512-mwpoNjHSWWh0IiALdDEQi3tru124JKn0yVNziIBzTME8QRv7thwoghVuT1jBRjFvdtoHsqD58IRHy1nf86paRg==
+"@actions/core@^1.2.6":
+  version "1.2.6"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.2.6.tgz#a78d49f41a4def18e88ce47c2cac615d5694bf09"
+  integrity sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==
 
 "@actions/exec@^1.0.4":
   version "1.0.4"