Adds info/changes for local action testing by MattKiazyk · Pull Request #46 · RobotsAndPencils/1password-action

MattKiazyk · 2020-11-27T21:33:29Z

Closes #45

Makes some changes so that we can test locally with ACT - https://github.com/nektos/act

Made a readme in actiontest/readme.md for more information.

Makes input values as secret so they can't be leaked to github console.

interstateone

I'm really glad that you figured out how to get act working, this will make the feedback cycle during development a lot shorter. I have a couple questions about these changes first but they're definitely a step in the right direction.

src/main.ts

actiontest/readme.md

interstateone · 2020-12-03T22:50:06Z

actiontest/readme.md

@@ -0,0 +1,11 @@
+To run locally. 
+
+1. Install ACT - https://github.com/nektos/act


You'll also need Docker Desktop on macOS installed and running. I know this might seem obvious but I didn't have it running, and in this case act just fails with zero output which is a bit mystifying.

interstateone · 2020-12-03T22:50:17Z

actiontest/readme.md

+To run locally. 
+
+1. Install ACT - https://github.com/nektos/act
+2. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j testLocal --secret-file actiontest/.secrets --env-file actiontest/.env


Suggested change

2. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j testLocal --secret-file actiontest/.secrets --env-file actiontest/.env

2. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j test --secret-file actiontest/.secrets --env-file actiontest/.env

I think this needs to change to be test to match the job name in test.yml, does that seem right or was this testLocal for another reason?

Thanks.. originally I had a separate workflow for testing locally (testLocal) this will become test

actiontest/readme.md

interstateone · 2020-12-03T22:52:43Z

actiontest/readme.md

+Couple of things:
+
+- need to use the `ubuntu-latest=nektos/act-environments-ubuntu:18.04` docker image which is 18 GB!
+- `test` - the name of your job from the test.yml


Suggested change

- `test` - the name of your job from the test.yml

- `test` - the name of your job from the .github/workflows/test.yml file.

interstateone · 2020-12-03T22:54:00Z

actiontest/action.yml

@@ -0,0 +1,28 @@
+name: '1Password Secrets'


Do we need this file? I'm not sure I understand how it ends up being used if we do, because it's not directly referenced by the act command in the README. I'd prefer to use the one in the root in the repo instead of duplicating it, but I'm not sure if that's possible.

So I could not get act to work properly using the regular action file and the regular test.yml

If you try to run the regular test.yml step that runs on github you'll get a

| Error: Cannot find module '/github/workspace/1password-action/dist/index.js'

Lots of people are having the same issue: nektos/act#391, nektos/act#185
Looks like an issue with the path when it copies. I tried a bunch of things, but one suggestion was to make a copy of your action.yml pointing it to '../dist/index.js' instead. This seemed to work.

I encountered this same problem and got to this PR from a reference in nektos/act#185. This file is not needed (we were doing the same). What needs to happen is that the action needs to add the location path to the checkout. Since the test action is using ./ then checkout path would be: path: "1password-action"

interstateone · 2020-12-03T22:57:01Z

.github/workflows/test.yml

+      - name: Test Action - local 
+        if: ${{ env.ACT }}
+        uses: ./actiontest
+        id: secretsLocal


Since we're assuming that only one of these Test Action steps ever runs, does this work if they both have the same step ID, and then we would only need the one verify step below?

alas, you would think, but I was getting errors when I had the same id on multiple steps. This may work on github runner but didn't seem to work on docker.

interstateone · 2020-12-03T22:57:35Z

.gitignore

+lib/**/*
+
+# For local action testing, these hold the secrets needed for testing.
+actiontest/.secrets


alfredodeza · 2020-12-07T17:54:07Z

.github/workflows/test.yml

-      - uses: ./
+      - name: Test Action - local 
+        if: ${{ env.ACT }}
+        uses: ./actiontest


this would need to change to:

Suggested change

uses: ./actiontest

uses: ./

alfredodeza · 2020-12-07T17:54:30Z

.github/workflows/test.yml

@@ -22,7 +22,23 @@ jobs:
    runs-on: ${{ matrix.runs-on }}
    steps:
      - uses: actions/checkout@v2


Suggested change

- uses: actions/checkout@v2

- uses: actions/checkout@v2

with:

path: "1password-action"

MattKiazyk · 2020-12-07T19:12:07Z

@alfredodeza Thank you very much for the direction! 🙇 That simplifies things alot!

interstateone

This works really well, thanks Matt!

One last question about file organization in the repo but otherwise good to 🚢

interstateone · 2020-12-09T15:40:21Z

package.json

  "description": "TypeScript template action",
  "main": "lib/main.js",
  "scripts": {
+    "act": "act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j test --secret-file actiontest/.secrets --env-file actiontest/.environment",


Good idea to add this here

interstateone · 2020-12-09T15:41:20Z

actiontest/readme.md

+1. Install Docker Desktop https://www.docker.com/products/docker-desktop
+2. Install ACT - https://github.com/nektos/act
+3. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j test --secret-file actiontest/.secrets --env-file actiontest/.environment


Suggested change

1. Install Docker Desktop https://www.docker.com/products/docker-desktop

2. Install ACT - https://github.com/nektos/act

3. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j test --secret-file actiontest/.secrets --env-file actiontest/.environment

1. Install Docker Desktop https://www.docker.com/products/docker-desktop

1. Install ACT - https://github.com/nektos/act

1. Copy .secrets-example to .secrets and replace `xxxx` with real values

1. Run `npm run act`

Adds the secrets step and prefer the act script. Also switched to let markdown rendering do the numbering correctly, which is a personal preference, because I find it makes it easier to edit later.

interstateone · 2020-12-09T15:42:47Z

actiontest/readme.md

@@ -0,0 +1,12 @@
+To run locally. 


I wonder if we could remove this directory and have its contents in the root, and part of the reason for that is the root README.md has a Development heading, where these steps might be more easily discoverable. If we do this we'll also need to update the .gitignore with the new secrets path.

MattKiazyk added 4 commits November 27, 2020 15:32

Adds info/changes for local action testing

2d567fa

Adjust typscript format for changing destination dir for op

f639b95

Add if option on verify tests

f8878c4

Set main inputs as secret

4bf5301

MattKiazyk requested a review from interstateone November 30, 2020 20:29

MattKiazyk assigned interstateone Nov 30, 2020

interstateone reviewed Dec 3, 2020

View reviewed changes

PR cleanup. Add act command to scripts for easier testing.

c848f03

MattKiazyk mentioned this pull request Dec 5, 2020

refactors 1password to better handle errors #48

Merged

alfredodeza reviewed Dec 7, 2020

View reviewed changes

MattKiazyk added 4 commits December 7, 2020 12:38

Fix up not having extra step to verify

8af9854

Merge branch 'main' into matt/localActionUpdates

a3044e8

rebuild after rebase

a8917bb

Have checkouts for local vs github

6923b2f

MattKiazyk requested a review from interstateone December 9, 2020 14:37

interstateone approved these changes Dec 9, 2020

View reviewed changes

Move actionTest directory contents to root.

8740e2e

MattKiazyk merged commit b6b1630 into main Dec 9, 2020

MattKiazyk deleted the matt/localActionUpdates branch December 9, 2020 16:17

		@@ -0,0 +1,11 @@
		To run locally.

		1. Install ACT - https://github.com/nektos/act

	2. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j testLocal --secret-file actiontest/.secrets --env-file actiontest/.env
	2. RUN: act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04 -j test --secret-file actiontest/.secrets --env-file actiontest/.env

	- `test` - the name of your job from the test.yml
	- `test` - the name of your job from the .github/workflows/test.yml file.

Conversation

MattKiazyk commented Nov 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

interstateone left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MattKiazyk commented Dec 7, 2020

Uh oh!

interstateone left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MattKiazyk commented Nov 27, 2020 •

edited

Loading