Skip to content

chore: Cherry-picked changes from upstream #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Raj-StepSecurity merged 9 commits into from
Mar 17, 2025
Merged

chore: Cherry-picked changes from upstream #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b68a0cd
Merge pull request #64 from Sam-Bate-ITV/feature/alternative_image
github-actions[bot] Mar 12, 2025
6e6d701
Merge pull request #64 from Sam-Bate-ITV/feature/alternative_image
github-actions[bot] Mar 12, 2025
3889dcb
Merge pull request #64 from Sam-Bate-ITV/feature/alternative_image
github-actions[bot] Mar 12, 2025
9b739c2
#62: add option for specifying image
Raj-StepSecurity Oct 25, 2024
b22a8e2
apply suggested change
Raj-StepSecurity Dec 9, 2024
a6ad994
use docker hub for CI
Raj-StepSecurity Dec 9, 2024
7175c56
readme changes
Raj-StepSecurity Jan 5, 2025
577cb06
bump node and mongodb versions
Raj-StepSecurity Jan 5, 2025
7a87800
readme updated
Raj-StepSecurity Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/test-auth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20]
mongodb-version: ['4.4', '5.0', '6.0']
node-version: [20, 22]
mongodb-version: ['5.0', '6.0', '7.0']
mongodb-db: ['ci']
mongodb-username: ['ci']
mongodb-password: ['ci']
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test-replica-set.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20]
mongodb-version: ['4.4', '5.0', '6.0']
node-version: [20, 22]
mongodb-version: ['5.0', '6.0', '7.0']

steps:
- name: Harden Runner
Expand Down Expand Up @@ -45,9 +45,9 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20]
node-version: [20, 22]
mongodb-port: [23456]
mongodb-version: ['4.4', '5.0', '6.0']
mongodb-version: ['5.0', '6.0', '7.0']

name: MongoDB v${{ matrix.mongodb-version }} RS, Port ${{ matrix.mongodb-port }} — Node.js v${{ matrix.node-version }}
steps:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test-single-instance.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20]
mongodb-version: ['4.4', '5.0', '6.0']
node-version: [20, 22]
mongodb-version: ['5.0', '6.0', '7.0']

steps:
- name: Harden Runner
Expand Down Expand Up @@ -46,8 +46,8 @@ jobs:
strategy:
matrix:
mongodb-port: [12345]
mongodb-version: ['4.4', '5.0', '6.0']
node-version: [18, 20]
mongodb-version: ['5.0', '6.0', '7.0']
node-version: [20, 22]

name: MongoDB v${{ matrix.mongodb-version }}, Port ${{ matrix.mongodb-port }} — Node.js v${{ matrix.node-version }}
steps:
Expand Down
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Start MongoDB
uses: step-security/mongodb-github-action@1.11.0
uses: step-security/mongodb-github-action@1.12.0
with:
# Here we are using an image from Amazon's ECR rather than the default image from Docker Hub
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}

- run: npm install
Expand Down Expand Up @@ -73,7 +75,7 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Start MongoDB
uses: step-security/mongodb-github-action@1.11.0
uses: step-security/mongodb-github-action@1.12.0
with:
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-replica-set: test-rs
Expand Down Expand Up @@ -117,7 +119,7 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Start MongoDB
uses: step-security/mongodb-github-action@1.11.0
uses: step-security/mongodb-github-action@1.12.0
with:
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-replica-set: test-rs
Expand All @@ -132,6 +134,18 @@ jobs:
CI: true
```

### Using a Custom Mongo Image
You can utilize an alternative MongoDB docker image using the `mongodb-image` input:


```yaml
- name: Start MongoDB
uses: step-security/[email protected]
Copy link
Contributor

@Raj-StepSecurity Raj-StepSecurity May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1.12

with:
# Here we are using an image from Amazon's ECR rather than the default image from Docker Hub
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}
```

### With Authentication (MongoDB `--auth` Flag)
Setting the `mongodb-username` and `mongodb-password` inputs. As per the [Dockerhub documentation](https://hub.docker.com/_/mongo), this automatically creates an admin user and enables `--auth` mode.
Expand Down Expand Up @@ -161,7 +175,7 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Start MongoDB
uses: step-security/mongodb-github-action@1.11.0
uses: step-security/mongodb-github-action@1.12.0
with:
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-username: supercharge
Expand Down Expand Up @@ -205,7 +219,7 @@ jobs:
node-version: ${{ matrix.node-version }}

- name: Start MongoDB
uses: step-security/mongodb-github-action@1.11.0
uses: step-security/mongodb-github-action@1.12.0
with:
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-container-name: mongodb-${{ matrix.node-version }}-${{ matrix.mongodb-version }}
Expand Down
2 changes: 2 additions & 0 deletions action-types.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# See https://github.com/krzema12/github-actions-typing
inputs:
mongodb-image:
type: string
mongodb-version:
type: string
mongodb-replica-set:
Expand Down
6 changes: 6 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ branding:
color: 'green'

inputs:
mongodb-image:
description: 'MongoDB image to use (defaults to using "mongo" from Docker Hub but you could also use an image from another repository such as Amazons "public.ecr.aws/docker/library/mongo")'
required: false
default: 'mongo'

mongodb-version:
description: 'MongoDB version to use (default "latest")'
required: false
Expand Down Expand Up @@ -45,6 +50,7 @@ runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.mongodb-image }}
- ${{ inputs.mongodb-version }}
- ${{ inputs.mongodb-replica-set }}
- ${{ inputs.mongodb-port }}
Expand Down
27 changes: 18 additions & 9 deletions start-mongodb.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
#!/bin/sh

# Map input values from the GitHub Actions workflow to shell variables
MONGODB_VERSION=$1
MONGODB_REPLICA_SET=$2
MONGODB_PORT=$3
MONGODB_DB=$4
MONGODB_USERNAME=$5
MONGODB_PASSWORD=$6
MONGODB_CONTAINER_NAME=$7
MONGODB_IMAGE=$1
MONGODB_VERSION=$2
MONGODB_REPLICA_SET=$3
MONGODB_PORT=$4
MONGODB_DB=$5
MONGODB_USERNAME=$6
MONGODB_PASSWORD=$7
MONGODB_CONTAINER_NAME=$8

# validate subscription status
API_URL="https://agent.api.stepsecurity.io/v1/github/$GITHUB_REPOSITORY/actions/subscription"
Expand All @@ -29,6 +30,13 @@ fi
# `mongosh` is used starting from MongoDB 5.x
MONGODB_CLIENT="mongosh --quiet"

if [ -z "$MONGODB_IMAGE" ]; then
echo ""
echo "Missing MongoDB image in the [mongodb-image] input. Received value: $MONGODB_IMAGE"
echo ""

exit 2
fi

if [ -z "$MONGODB_VERSION" ]; then
echo ""
Expand All @@ -38,6 +46,7 @@ if [ -z "$MONGODB_VERSION" ]; then
exit 2
fi

echo "::group::Using MongoDB Docker image $MONGODB_IMAGE:$MONGODB_VERSION"

echo "::group::Selecting correct MongoDB client"
if [ "`echo $MONGODB_VERSION | cut -c 1`" -le "4" ]; then
Expand Down Expand Up @@ -100,7 +109,7 @@ if [ -z "$MONGODB_REPLICA_SET" ]; then
echo " - container-name [$MONGODB_CONTAINER_NAME]"
echo ""

docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach mongo:$MONGODB_VERSION --port $MONGODB_PORT
docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach $MONGODB_IMAGE:$MONGODB_VERSION --port $MONGODB_PORT

if [ $? -ne 0 ]; then
echo "Error starting MongoDB Docker container"
Expand All @@ -121,7 +130,7 @@ echo " - replica set [$MONGODB_REPLICA_SET]"
echo ""


docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT --detach mongo:$MONGODB_VERSION --port $MONGODB_PORT --replSet $MONGODB_REPLICA_SET
docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT --detach $MONGODB_IMAGE:$MONGODB_VERSION --port $MONGODB_PORT --replSet $MONGODB_REPLICA_SET

if [ $? -ne 0 ]; then
echo "Error starting MongoDB Docker container"
Expand Down