feat: upgrade to v2

tests: setup tests

.github/workflows/tests.yml

@@ -0,0 +1,72 @@
+name: Docker Run Action Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  smoke-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run docker action and set output for testing
+        uses: ./
+        id: run-docker
+        with:
+          image: docker:20.10.3
+          run: |
+            echo "::set-output name=docker-version::`echo $DOCKER_VERSION`"
+      - name: Test the output
+        uses: actions/github-script@v3
+        with:
+          script: |
+            const dockerVersion = '${{ steps.run-docker.outputs.docker-version }}';
+            if (dockerVersion !== '20.10.3') {
+              core.setFailed(`Smoke Test Failed`);
+            }
+  volume-mount-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Create File to be mounted
+        run: echo "some text" > someFile
+      - name: Run docker action with mounted workspace
+        uses: ./
+        id: run-docker
+        with:
+          image: docker
+          options: -v ${{ github.workspace }}:/work
+          run: |
+            echo "::set-output name=file-contents::`cat /work/someFile`"
+      - name: Check if file contents match
+        uses: actions/github-script@v3
+        with:
+          script: |
+            const fileContents = '${{ steps.run-docker.outputs.file-contents }}';
+            if (fileContents !== 'some text') {
+              core.setFailed(`Unable to mount workspace volume`);
+            }
+  container-network-test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: test
+          POSTGRES_USER: test
+          POSTGRES_DB: test
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 5s --health-timeout 5s --health-retries 10
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run docker action and test network connection
+        uses: ./
+        with:
+          image: postgres
+          run: >
+            pg_isready -d test -U test -h postgres -p ${{ job.services.postgres.ports[5432] }}
+          options: >
+            -e PGPASSWORD=test

README.md

@@ -1,37 +1,56 @@
 # Docker Run Action
 
-This action targets a very specific use-case that is not currently supported by Github Workflows. This action gives you the capability to run built containers.
+- run a specific step in docker.
+- run an image built by a previous step.
+- See https://github.com/addnab/docker-run-action/blob/main/action.yml for all the available inputs.
 
-Docker already supports running commands inside a docker image. See [jobs.<jobs_id>.container](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer). But it doesn't give you a clean way to run an image from a private repo or an image built on a previous step.
+#### Typical Use Case
 
-### Example Usage
-
-#### Standard use-case
 ```yaml
-- uses: addnab/docker-run-action@v1
+- uses: addnab/docker-run-action@v2
+  with:
+    username: ${{ secrets.DOCKER_USERNAME }}
+    password: ${{ secrets.DOCKER_PASSWORD }}
+    registry: gcr.io
+    image: private-image:latest
+    options: -v ${{ github.workspace }}:/work -e ABC=123
+    run: |
+      echo "Running Script"
+      /work/run-script
+```
+
+#### run a privately-owned image
+```yaml
+- uses: addnab/docker-run-action@v2
+  with:
+    username: ${{ secrets.DOCKER_USERNAME }}
+    password: ${{ secrets.DOCKER_PASSWORD }}
+    registry: gcr.io
+    image: test-image:latest
+    run: echo "hello world"
+```
+
+#### run an image built by a previous step
+```yaml
+- uses: docker/build-push-action@v1
+  with:
+    repository: test-image
+    push: false
+- uses: addnab/docker-run-action@v2
+  with:
+    image: test-image:latest
+    run: echo "hello world"
+```
+
+
+#### use a specific shell (default: sh). 
+*Note: The shell must be installed in the container*
+```yaml
+- uses: addnab/docker-run-action@v2
   with:
     image: docker:latest
-    command: echo "hello world"
-```
-
-### Supported Inputs
-```yaml
-  image:
-    description: 'Image'
-    required: true
-  options:
-    description: 'Options'
-    required: false
-  command:
-    description: 'Command'
-    required: false
-  registry:
-    description: 'Registry'
-    required: false
-  username:
-    description: 'Username'
-    required: false
-  password:
-    description: 'Password'
-    required: false
+    shell: bash
+    run: |
+      echo "first line"
+      echo "second line"
 ```

RELEASES.md

@@ -0,0 +1,10 @@
+# addnab/docker-run-action Releases
+
+### 2.0.0
+
+- Added support for networking with other containers [#3](https://github.com/addnab/docker-run-action/pull/3) [#7](https://github.com/addnab/docker-run-action/pull/7)
+- Added tests [#7](https://github.com/addnab/docker-run-action/pull/7)
+
+### 1.0.0
+
+- Initial release

action.yml

@@ -8,9 +8,13 @@ inputs:
   options:
     description: 'Options'
     required: false
-  command:
-    description: 'Command'
+  run:
+    description: 'Run command in container'
     required: false
+  shell:
+    description: 'Use a specific shell'
+    required: false
+    default: sh
   registry:
     description: 'Registry'
     required: false
@@ -20,6 +24,10 @@ inputs:
   password:
     description: 'Password'
     required: false
+  docker_network:
+    description: 'Docker Network ID'
+    default: ${{ job.container.network }}
+    retuired: false
 runs:
   using: 'docker'
   image: 'Dockerfile'

entrypoint.sh

@@ -1,7 +1,13 @@
 #!/usr/bin/env bash
 
 if [ ! -z $INPUT_USERNAME ];
-then echo $INPUT_USERNAME | docker login $INPUT_REGISTRY -u $INPUT_PASSWORD --password-stdin
+then echo $INPUT_PASSWORD | docker login $INPUT_REGISTRY -u $INPUT_USERNAME --password-stdin
 fi
 
-exec docker run $INPUT_OPTIONS $INPUT_IMAGE $INPUT_COMMAND
+echo "$INPUT_RUN" | sed -e 's/\\n/;/g' > semicolon_delimited_script
+
+if [ ! -z $INPUT_DOCKER_NETWORK ];
+then INPUT_OPTIONS="$INPUT_OPTIONS --network $INPUT_DOCKER_NETWORK"
+fi
+
+exec docker run -v "/var/run/docker.sock":"/var/run/docker.sock" $INPUT_OPTIONS --entrypoint=$INPUT_SHELL $INPUT_IMAGE -c "`cat semicolon_delimited_script`"