Enable parameter handling (#6)

cmeissner · web-flow · commit c89111b7d5d4 · 2022-01-19T15:51:09.000+01:00
With this commit we enabled handling of action input parameters. From
now you can provide the following parameters:

* ipam_version
* ipam_database_host
* ipam_database_user
* ipam_database_pass
* ipam_database_name
* database_root_password

All of these parameters are optional and default values will be
guarantee a working environment anyways.

We also extend our existing tests by providing inputs by environment
variables and test the newly configured database as well.
Finally we demonstrate in the test workflow the ability to use matrix
builds.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -3,13 +3,44 @@ on:
   - push
   - pull_request
 
+env:
+  IPAM_VERSION: '1.4x'
+  IPAM_DATABASE_HOST: 'database'
+  IPAM_DATABASE_USER: 'ipamuser'
+  IPAM_DATABASE_PASS: 'ipampass'
+  IPAM_DATABASE_NAME: 'ipamdb'
+  DATABASE_ROOT_PASS: 'v3ryS3cureP4ssw0rd'
+
 jobs:
   check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: run phpipam-action
         uses: ./ # use action in the root directory
-      - name: "Test phpipam api"
+        with:
+          ipam_version: ${{ env.IPAM_VERSION }}
+          ipam_database_host: ${{ env.IPAM_DATABASE_HOST }}
+          ipam_database_user: ${{ env.IPAM_DATABASE_USER }}
+          ipam_database_pass: ${{ env.IPAM_DATABASE_PASS }}
+          ipam_database_name: ${{ env.IPAM_DATABASE_NAME }}
+          database_root_password: ${{ env.DATABASE_ROOT_PASS }}
+      - name: "Test phpipam api and database"
+        run: |
+          curl -k --user Admin:ipamadmin -X POST https://localhost/api/ansible/user/
+          mysql -h 127.0.01 -u ${{ env.IPAM_DATABASE_USER }} -p${{ env.IPAM_DATABASE_PASS }} ${{ env.IPAM_DATABASE_NAME }} --execute="SHOW TABLES"
+  matrix_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        phpipam: ['1.4x','1.5x']
+    steps:
+      - uses: actions/checkout@v2
+      - name: run phpipam-action
+        uses: ./ # use action in the root directory
+        with:
+          ipam_version: ${{ matrix.phpipam }}
+      - name: "Test phpipam api and database"
         run: |
           curl -k --user Admin:ipamadmin -X POST https://localhost/api/ansible/user/
+          mysql -h 127.0.01 -u ${{ env.IPAM_DATABASE_USER }} -p${{ env.IPAM_DATABASE_PASS }} ${{ env.IPAM_DATABASE_NAME }} --execute="SHOW TABLES"
diff --git a/README.md b/README.md
@@ -11,36 +11,38 @@ In detail the action start two containers:
 
 After that the action does a few things to prepare the phpipam installation:
 
-* populate the database with a default data
+* populate the database with default data
 * activate the api
-* create a app for api connection
+* create an app for api connection
 * set required password change for defaut admin to _no_ - this is for local testing purposes
 
 ## Parameters
 
----
-**Note:**
-
-There are several parameters defined in readme. These parameters were currently not used but they are here for future use.
-
----
-
-The parameters are prepared as follows:
+We provide the following parameters to configure the phpipam instance database:
 
+* **ipam_version**: the phpipam version to install: Default: "latest"
 * **ipam_database_host**: Database host phpipam connects to. Default: "database"
 * **ipam_database_user**: Database user phpipam needs to authenticate. Default: "phpipam"
 * **ipam_database_pass**: Database password phpipam needs to authenticate. Default: "phpipam"
 * **ipam_database_name**: Database name phpipam uses. Default: "phpipam"
 * **database_root_password**: Root password for the database. Default: "root"
 
+---
+
+**Note:** If you define a database host, the database (**ipam_database_name**) needs to be created or emptied  before the action can be executed.
+
+---
+
 ## Usage
 
-The action is hosted in a separate repository and available on [github marketplace](https://github.com/marketplace/actions/phpipam-action){:target="_blank"}. To use it you have to add the following to your github workflow:
+The action is hosted in a separate repository and available on [github marketplace](https://github.com/marketplace/actions/phpipam-action). To use it you have to add the following to your github workflow:
 
 ~~~yaml
 steps:
   - uses: actions/checkout@v2
-  - uses: codeaffen/phpipam-action@v1
+  - uses: codeaffen/phpipam-action@v2
+    with:
+      ipam_version: "1.4x"
 ~~~
 
 If the action finishes successfully you will be able to run your api tests against the phpipam installation.
@@ -50,3 +52,17 @@ If the action finishes successfully you will be able to run your api tests again
         run: |
           curl -k --user Admin:ipamadmin -X POST https://localhost/api/ansible/user/
 ~~~
+
+With the `ipam_version` parameter you will be able to test against different phpipam versions by using githubs build matrix feature. This is done by defining a job as follows:
+
+~~~yaml
+strategy:
+      matrix:
+        phpipam: ['1.4x','1.5x']
+    steps:
+      - uses: actions/checkout@v2
+      - name: run phpipam-action
+        uses: codeaffen/phpipam-action@v2
+        with:
+          ipam_version: ${{ matrix.phpipam }}
+~~~
diff --git a/action.yml b/action.yml
@@ -1,6 +1,10 @@
 name: 'phpIPAM Action'
 description: 'Spin up a phpIPAM instance'
 inputs:
+  ipam_version:
+    description: 'phpIPAM version to install'
+    required: false
+    default: 'latest'
   ipam_database_host:
     description: 'database host phpipam connects to'
     required: false
diff --git a/dist/docker-compose.yml b/dist/docker-compose.yml
@@ -1,22 +1,22 @@
 version: '3'
 services:
   phpipam:
-    image: phpipam/phpipam-www:v1.4.4
+    image: phpipam/phpipam-www:${IPAM_VERSION:-1.4x}
     ports:
       - "443:443"
     environment:
-      IPAM_DATABASE_HOST: "database"
-      IPAM_DATABASE_USER: "phpipam"
-      IPAM_DATABASE_PASS: "phpipamadmin"
-      IPAM_DATABASE_NAME: "phpipam"
+      IPAM_DATABASE_HOST: "${IPAM_DATABASE_HOST:-database}"
+      IPAM_DATABASE_USER: "${IPAM_DATABASE_USER:-phpipam}"
+      IPAM_DATABASE_PASS: "${IPAM_DATABASE_PASS:-phpipamadmin}"
+      IPAM_DATABASE_NAME: "${IPAM_DATABASE_NAME:-phpipam}"
     depends_on:
       - database
   database:
     image: mariadb:10.3.18
     ports:
       - "3306:3306"
     environment:
-      MYSQL_ROOT_PASSWORD: "rootpw"
-      MYSQL_USER: "phpipam"
-      MYSQL_PASSWORD: "phpipamadmin"
-      MYSQL_DATABASE: "phpipam"
+      MYSQL_ROOT_PASSWORD: "${MYSQL_ROOT_PASSWORD:-rootpw}"
+      MYSQL_USER: "${IPAM_DATABASE_USER:-phpipam}"
+      MYSQL_PASSWORD: "${IPAM_DATABASE_PASS:-phpipamadmin}"
+      MYSQL_DATABASE: "${IPAM_DATABASE_NAME:-phpipam}"
diff --git a/dist/exec.yml b/dist/exec.yml
@@ -3,7 +3,7 @@ exec_list:
   - name: init database
     container: phpipam
     commands:
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam < /phpipam/db/SCHEMA.sql"]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"UPDATE settings SET api=1 WHERE id=1;\""]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"INSERT INTO api (app_id, app_code, app_permissions, app_security, app_lock_wait) VALUES ('ansible','aAbBcCdDeEfF00112233445566778899',2,'ssl_token',0);\""]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"UPDATE users SET passChange = 'No' WHERE username = 'Admin';\""]
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} < /phpipam/db/SCHEMA.sql']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="UPDATE settings SET api=1 WHERE id=1;"']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="INSERT INTO api (app_id, app_code, app_permissions, app_security, app_lock_wait) VALUES (\"ansible\",\"aAbBcCdDeEfF00112233445566778899\",2,\"ssl_token\",0);"']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="UPDATE users SET passChange = \"No\" WHERE username = \"Admin\";"']
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/index.js b/index.js
@@ -35,6 +35,7 @@ async function down() {
 async function execInContainer(container, commands, options={}) {
     for(const c of commands)
     {
+        core.debug(`executing "${c}" inside "${container}"`);
         await compose.exec(container, c, options);
     }
 }
@@ -66,6 +67,13 @@ try {
     core.setFailed(error.message);
 }
 
+process.env.PHPIPAM_VERSION = core.getInput("phpipam_version");
+process.env.PHPIPAM_DATABASE_HOST = core.getInput("phpipam_database_host");
+process.env.PHPIPAM_DATABASE_USER = core.getInput("phpipam_database_user");
+process.env.PHPIPAM_DATABASE_PASS = core.getInput("phpipam_database_pass");
+process.env.PHPIPAM_DATABASE_NAME = core.getInput("phpipam_database_name");
+process.env.MYSQL_ROOT_PASSWORD = core.getInput("database_root_password");
+
 switch (myArgs[0]) {
     case "up":
         up();
@@ -77,7 +85,7 @@ switch (myArgs[0]) {
         down();
         break;
     default:
-        core.info("staring phpipam in action mode");
+        core.info(`staring phpipam (${process.env.PHPIPAM_VERSION}) in action mode`);
         up();
         setTimeout(init, 30000);
 }
diff --git a/services/docker-compose.yml b/services/docker-compose.yml
@@ -1,22 +1,22 @@
 version: '3'
 services:
   phpipam:
-    image: phpipam/phpipam-www:v1.4.4
+    image: phpipam/phpipam-www:${IPAM_VERSION:-1.4x}
     ports:
       - "443:443"
     environment:
-      IPAM_DATABASE_HOST: "database"
-      IPAM_DATABASE_USER: "phpipam"
-      IPAM_DATABASE_PASS: "phpipamadmin"
-      IPAM_DATABASE_NAME: "phpipam"
+      IPAM_DATABASE_HOST: "${IPAM_DATABASE_HOST:-database}"
+      IPAM_DATABASE_USER: "${IPAM_DATABASE_USER:-phpipam}"
+      IPAM_DATABASE_PASS: "${IPAM_DATABASE_PASS:-phpipamadmin}"
+      IPAM_DATABASE_NAME: "${IPAM_DATABASE_NAME:-phpipam}"
     depends_on:
       - database
   database:
     image: mariadb:10.3.18
     ports:
       - "3306:3306"
     environment:
-      MYSQL_ROOT_PASSWORD: "rootpw"
-      MYSQL_USER: "phpipam"
-      MYSQL_PASSWORD: "phpipamadmin"
-      MYSQL_DATABASE: "phpipam"
+      MYSQL_ROOT_PASSWORD: "${MYSQL_ROOT_PASSWORD:-rootpw}"
+      MYSQL_USER: "${IPAM_DATABASE_USER:-phpipam}"
+      MYSQL_PASSWORD: "${IPAM_DATABASE_PASS:-phpipamadmin}"
+      MYSQL_DATABASE: "${IPAM_DATABASE_NAME:-phpipam}"
diff --git a/services/exec.yml b/services/exec.yml
@@ -3,7 +3,7 @@ exec_list:
   - name: init database
     container: phpipam
     commands:
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam < /phpipam/db/SCHEMA.sql"]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"UPDATE settings SET api=1 WHERE id=1;\""]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"INSERT INTO api (app_id, app_code, app_permissions, app_security, app_lock_wait) VALUES ('ansible','aAbBcCdDeEfF00112233445566778899',2,'ssl_token',0);\""]
-      - ["sh", "-c", "mysql -h database -u phpipam -pphpipamadmin phpipam --execute=\"UPDATE users SET passChange = 'No' WHERE username = 'Admin';\""]
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} < /phpipam/db/SCHEMA.sql']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="UPDATE settings SET api=1 WHERE id=1;"']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="INSERT INTO api (app_id, app_code, app_permissions, app_security, app_lock_wait) VALUES (\"ansible\",\"aAbBcCdDeEfF00112233445566778899\",2,\"ssl_token\",0);"']
+      - ["sh", "-c", 'mysql -h ${IPAM_DATABASE_HOST} -u ${IPAM_DATABASE_USER} -p${IPAM_DATABASE_PASS} ${IPAM_DATABASE_NAME} --execute="UPDATE users SET passChange = \"No\" WHERE username = \"Admin\";"']

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ async function down() {`
`35`	`35`	`async function execInContainer(container, commands, options={}) {`
`36`	`36`	`for(const c of commands)`
`37`	`37`	`{`
	`38`	+ core.debug(`executing "${c}" inside "${container}"`);
`38`	`39`	`await compose.exec(container, c, options);`
`39`	`40`	`}`
`40`	`41`	`}`
`@@ -66,6 +67,13 @@ try {`
`66`	`67`	`core.setFailed(error.message);`
`67`	`68`	`}`
`68`	`69`
	`70`	`+process.env.PHPIPAM_VERSION = core.getInput("phpipam_version");`
	`71`	`+process.env.PHPIPAM_DATABASE_HOST = core.getInput("phpipam_database_host");`
	`72`	`+process.env.PHPIPAM_DATABASE_USER = core.getInput("phpipam_database_user");`
	`73`	`+process.env.PHPIPAM_DATABASE_PASS = core.getInput("phpipam_database_pass");`
	`74`	`+process.env.PHPIPAM_DATABASE_NAME = core.getInput("phpipam_database_name");`
	`75`	`+process.env.MYSQL_ROOT_PASSWORD = core.getInput("database_root_password");`
	`76`	`+`
`69`	`77`	`switch (myArgs[0]) {`
`70`	`78`	`case "up":`
`71`	`79`	`up();`
`@@ -77,7 +85,7 @@ switch (myArgs[0]) {`
`77`	`85`	`down();`
`78`	`86`	`break;`
`79`	`87`	`default:`
`80`		`- core.info("staring phpipam in action mode");`
	`88`	+ core.info(`staring phpipam (${process.env.PHPIPAM_VERSION}) in action mode`);
`81`	`89`	`up();`
`82`	`90`	`setTimeout(init, 30000);`
`83`	`91`	`}`