feat: added logs and updated readme (#476)

* feat: added logs and updated readme

* feat: updated siteminder tests volume mount path

* feat: updated readmes

Author: NithinKuruba

docker/kc-cron-job/.env.example

@@ -26,3 +26,6 @@ BCEID_REQUESTER_IDIR_GUID=
 BCEID_SERVICE_ID_DEV=
 BCEID_SERVICE_ID_TEST=
 BCEID_SERVICE_ID_PROD=
+
+GH_SITMINDER_TESTS_APP_ID=
+GH_SITMINDER_TESTS_INSTALLATION_ID=

docker/kc-cron-job/README.md

@@ -42,6 +42,13 @@ MS_GRAPH_API_CLIENT_SECRET_PROD=
 
 will be required. They are not currently needed.
 
+### Github App for Siteminder Tests
+
+- Navigate to SSO Team's Github account profile settings and create a Github App. Choose `Any account` for this app to be installed.
+- Assign `Actions: read, write` permissions
+- Install the app on the `bcgov` org and `sso-keycloak` repository
+- Generate a private key and save it in the `keys` folder inside root of the crob job repo (`./sso-keycloak/docker/kc-cron-job`) with name `github-siteminder-tests-private-key.pem`
+
 ## Deployment
 
 The cron jobs can be redeployed from the [helm chart](../../helm/kc-cron-job/README.md). The repository contains make commands for deploying and upgrading.

docker/kc-cron-job/siteminder-tests.js

@@ -6,7 +6,7 @@ import { sendRcNotification } from './helpers.js';
 
 dotenv.config();
 
-const privateKey = fs.readFileSync('./github-siteminder-tests-private-key.pem', 'utf8');
+const privateKey = fs.readFileSync('./keys/github-siteminder-tests-private-key.pem', 'utf8');
 
 async function runTests(octokit, environment) {
   try {
@@ -31,9 +31,11 @@ async function runTests(octokit, environment) {
 }
 
 async function main() {
+  console.info('Starting siteminder-tests');
   try {
     let octokit;
     try {
+      console.info('Authenticating with github application');
       octokit = new Octokit({
         authStrategy: createAppAuth,
         auth: {
@@ -49,11 +51,13 @@ async function main() {
       throw new Error('Failed to authenticate with github application');
     }
 
+    console.info('Starting siteminder tests...');
     await runTests(octokit, 'DEV');
 
     await runTests(octokit, 'TEST');
 
     if (new Date().getDay() === 0) await runTests(octokit, 'PROD');
+    console.info('Completed');
   } catch (err) {
     console.error(err);
     await sendRcNotification('siteminder-tests', `**${err}** \n\n` + JSON.stringify(err), true);

helm/kc-cron-job/README.md

@@ -12,10 +12,10 @@ The deployment steps for a new namespace follow:
 
 ### Github App for Siteminder Tests
 
-- Navigate to SSO Team's Github account profile settings and create a Github App
+- Navigate to SSO Team's Github account profile settings and create a Github App. Choose `Any account` for this app to be installed.
 - Assign `Actions: read, write` permissions
-- Install the app on the user account
-- Generate a private key and save it in the root of the crob job repo (`./sso-keycloak/docker/kc-cron-job`) with name `github-siteminder-tests-private-key.pem`
+- Install the app on the `bcgov` org and `sso-keycloak` repository
+- Generate a private key and save it in the `keys` folder inside root of the crob job repo (`./sso-keycloak/docker/kc-cron-job`) with name `github-siteminder-tests-private-key.pem`
 
 ### Create `kc-cron-job-secret` secret
 

helm/kc-cron-job/templates/cron-siteminder-tests.yaml

@@ -46,7 +46,7 @@ spec:
                       key: rc-webhook
               volumeMounts:
                 - name: github-siteminder-tests-private-key
-                  mountPath: "/usr/src/app"
+                  mountPath: "/usr/src/app/keys"
                   readOnly: true
           volumes:
           - name: github-siteminder-tests-private-key