Change created to executed (#32)

* removed JSON file creation, showing only JSON blob

* updated makefile

* changed DB_CONN_STR to env variable

* Add ENV vars for checkmake (#15)

* Changed created_by field to executed_by

* linting changes

---------

Co-authored-by: Shir Moran <[email protected]>
Co-authored-by: Brandon Palm <[email protected]>

Author: 3 people

Makefile

@@ -102,7 +102,12 @@ build-image-collector:
 build-and-deploy-image-collector-dev:
 	docker build -f Dockerfile -t ${REGISTRY}/${COLLECTOR_IMAGE_NAME}:dev
 	docker push ${REGISTRY}/${COLLECTOR_IMAGE_NAME}:dev
-	sed 's/latest/dev/g' ${COLLECTOR_DEPLOYMENT_PATH} > collector-deployment-dev.yml
+# temporary replacement for secret to able local testing
+	sed \
+		-e 's/latest/dev/g' \
+		-e 's/\$${{ secrets.MYSQL_USERNAME }}/Y29sbGVjdG9ydXNlcg==/g' \
+		-e 's/\$${{ secrets.MYSQL_PASSWORD }}/cGFzc3dvcmQ='/g \
+		${COLLECTOR_DEPLOYMENT_PATH} > collector-deployment-dev.yml
 	oc apply -f ./collector-deployment-dev.yml
 	rm collector-deployment-dev.yml
 
@@ -111,12 +116,13 @@ remove-image-collector-and-deployment-dev:
 	oc delete deployment collector-deployment
 
 deploy-mysql:
-	oc apply -f ${MYSQL_PV_PATH}
-	oc apply -f ${MYSQL_DEPLOYMENT_PATH}
+# temporary replacement for secret to able local testing
+	sed -e 's/\$${{ secrets.DB_ROOT_PASSWORD }}/YWRtaW4=/g' ${MYSQL_DEPLOYMENT_PATH} > mysql-deployment-dev.yaml
+	oc apply -f mysql-deployment-dev.yaml
+	rm mysql-deployment-dev.yaml
 
 delete-mysql:
 	oc delete -f ${MYSQL_DEPLOYMENT_PATH}
-	oc delete -f ${MYSQL_PV_PATH}
 
 deploy-collector:
 	oc apply -f ${COLLECTOR_DEPLOYMENT_PATH}

README.md

@@ -28,6 +28,6 @@ Cleanup after:
 
 From collector's repo root directory, use the following command:
 
-`./send-to-collector.sh "path/to/claim.json" "enter_created_by" "enter_partner_name"`
+`./send-to-collector.sh "path/to/claim.json" "enter_executed_by" "enter_partner_name"`
 
 

actions/constants.go

@@ -18,7 +18,7 @@ const TestStateMissingErr = MalformedClaimFileErr + "state subfield of %s test i
 const TestIDSuiteMissingErr = MalformedClaimFileErr + "suite subfield of %s's testID field is missing."
 const TestIDIDMissingErr = MalformedClaimFileErr + "id subfield of %s's testID field is missing."
 const ResultsFieldMissingErr = MalformedClaimFileErr + "results field is missing."
-const CreatedByMissingErr = MalformedClaimFileErr + "created by value is missing."
+const ExecutedByMissingErr = MalformedClaimFileErr + "executed by value is missing."
 const MalformedJSONFileErr = "Malformed json file."
 const RollbackErr = "Error found while Rollbacking transaction: %s"
 const ExecQueryErr = "Error found while executing a mysql query: %s"
@@ -31,12 +31,12 @@ const ClaimTag = "claim"
 const VersionsTag = "versions"
 const ResultsTag = "results"
 const ClaimFileInputName = "claimFile"
-const CreatedByInputName = "created_by"
+const ExecutedByInputName = "executed_by"
 const PartnerNameInputName = "partner_name"
 
 const UseCollectorSQLCmd = `USE cnf; `
 const InsertToClaimSQLCmd = `INSERT INTO claim 
-								(cnf_version, created_by, upload_time, partner_name)
+								(cnf_version, executed_by, upload_time, partner_name)
 								VALUES (?, ?, ?, ?);`
 const InsertToClaimResSQLCmd = `INSERT INTO claim_result
 							(claim_id, suite_name, test_id, test_status)

actions/parser.go

@@ -95,16 +95,16 @@ func insertToClaimTable(w http.ResponseWriter, r *http.Request, tx *sql.Tx, clai
 		return false
 	}
 
-	// saving users input referring to who created claim file and partner's name
-	createdBy := r.FormValue(CreatedByInputName)
+	// saving users input referring to who executed claim file and partner's name
+	executedBy := r.FormValue(ExecutedByInputName)
 	partnerName := r.FormValue(PartnerNameInputName)
 
-	if createdBy == "" {
-		writeResponse(w, "%s", CreatedByMissingErr)
+	if executedBy == "" {
+		writeResponse(w, "%s", ExecutedByMissingErr)
 		return false
 	}
 
-	_, err := tx.Exec(InsertToClaimSQLCmd, versions["ocp"].(string), createdBy, time.Now(), partnerName)
+	_, err := tx.Exec(InsertToClaimSQLCmd, versions["ocp"].(string), executedBy, time.Now(), partnerName)
 	if err != nil {
 		handleTransactionRollback(tx, err, ExecQueryErr)
 		return false

actions/results.go

@@ -12,7 +12,7 @@ import (
 type Claim struct {
 	ID            int    `json:"id"`
 	CnfVersion    string `json:"cnf_version"`
-	CreatedBy     string `json:"created_by"`
+	ExecutedBy    string `json:"executed_by"`
 	UploadTime    string `json:"upload_time"`
 	PartnerName   string `json:"partner_name"`
 	MarkForDelete bool   `json:"mark_for_delete"`
@@ -49,7 +49,7 @@ func mapClaimsToStruct(claimRows *sql.Rows) []Claim {
 	var claims []Claim
 	for claimRows.Next() {
 		var row Claim
-		err := claimRows.Scan(&row.ID, &row.CnfVersion, &row.CreatedBy, &row.UploadTime, &row.PartnerName, &row.MarkForDelete)
+		err := claimRows.Scan(&row.ID, &row.CnfVersion, &row.ExecutedBy, &row.UploadTime, &row.PartnerName, &row.MarkForDelete)
 		if err != nil {
 			logrus.Errorf(ScanDBFieldErr, err)
 		}

deployment/database/create_schema.sql

@@ -4,7 +4,7 @@ use cnf;
 create table if not exists claim (
   id int not null AUTO_INCREMENT,
   cnf_version varchar(50) not null,
-  created_by  varchar(50) not null,
+  executed_by  varchar(50) not null,
   upload_time datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
   partner_name varchar(50),
   mark_for_delete boolean DEFAULT false,

deployment/database/testdata.sql

@@ -1,14 +1,14 @@
 use cnf;
 
-insert into claim (cnf_version, created_by, partner_name) values ('v4.2.1', 'QE', 'Partner-1');
+insert into claim (cnf_version, executed_by, partner_name) values ('v4.2.1', 'QE', 'Partner-1');
 insert into claim_result (claim_id, suite_name, test_id, test_status)
   (select (select max(id) from claim), 'lifecycle', 'scaling-test-1', 'pass');
 insert into claim_result (claim_id, suite_name, test_id, test_status)
   (select (select max(id) from claim), 'lifecycle', 'scaling-test-2', 'skip');
 insert into claim_result (claim_id, suite_name, test_id, test_status)
     (select (select max(id) from claim), 'lifecycle', 'scaling-test-3', 'pass');
 
-insert into claim (cnf_version, created_by, partner_name) values ('v4.2.1', 'QE', 'Partner-2');
+insert into claim (cnf_version, executed_by, partner_name) values ('v4.2.1', 'QE', 'Partner-2');
 insert into claim_result (claim_id, suite_name, test_id, test_status)
   (select (select max(id) from claim), 'affiliated-certification', 'kernel-test', 'fail');
 insert into claim_result (claim_id, suite_name, test_id, test_status)

deployment/k8s/mysql-deployment.yaml

@@ -95,7 +95,7 @@ data:
     create table if not exists claim (
       id int not null AUTO_INCREMENT,
       cnf_version varchar(50) not null,
-      created_by  varchar(50) not null,
+      executed_by  varchar(50) not null,
       upload_time datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
       partner_name varchar(50),
       mark_for_delete boolean DEFAULT false,

index.html

@@ -10,8 +10,8 @@
       <label for="claimFile">Claim File:</label>
       <input type="file" name="claimFile" />
 
-      <label for="created_by">Created by:</label>
-      <input type="text" id="created_by" name="created_by" />
+      <label for="executed_by">Executed by:</label>
+      <input type="text" id="executed_by" name="executed_by" />
 
       <label for="partner_name">Partner name:</label>
       <input type="text" id="partner_name" name="partner_name" />

send-to-collector.sh

@@ -1,12 +1,12 @@
 #!/bin/bash
 
 claimFile="$1"
-createdBy="$2"
+executedBy="$2"
 partnerName="$3"
 endpoint="http://localhost:8080"
 
 curl -X POST $endpoint \
     -H "Content-Type: multipart/form-data" \
     -F "claimFile=@$claimFile" \
-    -F "created_by=$createdBy" \
+    -F "executed_by=$executedBy" \
     -F "partner_name=$partnerName"