util

Documentation

Index

• Constants
• func GetClaimFile(w http.ResponseWriter, r *http.Request) multipart.File
• func GetCollectorTablesByPartner(db *sql.DB, partnerName string) (claimRows, claimResultsRows *sql.Rows)
• func GetDatabaseEnvVars() (user, password, dbURL, port string)
• func GetEntireCollectorTable(db *sql.DB) (claimRows, claimResultsRows *sql.Rows)
• func GetS3ConnectEnvVars() (s3BucketName, region, accessKey, secretAccessKey string)
• func GetServerEnvVars() (readTimeOutInt, writeTimeOutInt int, addr, err string)
• func HandleTransactionRollback(tx *sql.Tx)
• func ReadClaimFile(w http.ResponseWriter, r *http.Request) ([]byte, error)
• func StoreClaimFileInDatabase(db *sql.DB, claimResult []types.ClaimResult, ...) error
• func WriteMsg(w http.ResponseWriter, err string)

Constants

const AdminUserName = "admin"

const AuthError = "Error found while authenticating partner's password: %s"

const BeginTxErr = "Error found while beginning transaction: %s"

const ClaimFieldMissingErr = "claim field is missing"

const ClaimFileError = "Error while storing the claim file in the database: %s"

const ClaimFileInputName = "claimFile"

const ClaimTag = "claim"

const CommitTxErr = "Error found while committing transaction: %s"

const DedcodedPasswordInputName = "decoded_password"

const EmptyClaimFileErr = "claim file is empty"

const EncodingPasswordError = "Failed encoding password" // #nosec

const ExecQueryErr = "Error found while executing a mysql query: %s"

const ExecutedByInputName = "executed_by"

const ExecutedByMissingErr = "executed by value is missing"

const ExtractLastClaimID = `SELECT id FROM cnf.claim ORDER BY id DESC LIMIT 1;`

const ExtractPartnerAndPasswordCmd = `SELECT encoded_password FROM cnf.authenticator WHERE partner_name = ?`

const FailedToDeleteFileFromS3Err = "Error found while trying to delete file from s3: %s"

const FailedToUploadFileToS3Err = "Error found while trying to upload claim file to bucket: %s"

const FileHasBeenDeletedFromBucket = `Claim file has been deleted from bucket %s`

const FileStoredIntoClaimResultTableSuccessfully = `Claim is stored into table CLAIM_RESULT successfully.`

const FileStoredIntoClaimTableSuccessfully = `Claim is stored into table successfully.`

const FileUploadedSuccessfullyToBucket = `Claim file is successfully uploaded to bucket %s`

const FormFileErr = "Error found while forming file: %s"

const InsertPartnerToAuthSQLCmd = `INSERT INTO cnf.authenticator (partner_name, encoded_password) VALUES (?, ?)`

const InsertToClaimResSQLCmd = `INSERT INTO claim_result
							(claim_id, suite_name, test_id, test_status)
							VALUES (?, ?, ?, ?);`

const InsertToClaimSQLCmd = `INSERT INTO claim
								(cnf_version, executed_by, upload_time, partner_name, s3_file_key)
								VALUES (?, ?, ?, ?, ?);`

const InvalidPasswordErr = "wrong password"

const InvalidRequestErr = "Invalid request."

const InvalidUsernameErr = "partner is not found"

const MalformedClaimFileErr = "Malformed claim file: %s"

const MarshalErr = "Error found while marshaling claim file: %s"

const OcpFieldMissingErr = "ocp subfield of versions field is missing"

const ParseLowerBound = 10

const ParseUpperBound = 20

const PartnerNameInputName = "partner_name"

const PartnerOrPasswordArgsMissingErr = "partner name or Password are not given"

const PostRequestIsNotValidErr = "Post request isn't valid: %s"

const RequestContentTypeErr = "Error found while Parsing multipart form: %s"

const ResultsFieldMissingErr = "results field is missing"

const ResultsTag = "results"

const RollbackErr = "Error found while Rollbacking transaction: %s"

const ScanDBFieldErr = "Error found while scanning db field: %s"

const SelectAllClaimIDsByPartner = "SELECT id FROM cnf.claim WHERE partner_name = ?"

const SelectAllFromClaim = "SELECT * FROM cnf.claim"

const SelectAllFromClaimByPartner = "SELECT * FROM cnf.claim WHERE partner_name = ?"

const SelectAllFromClaimResult = "SELECT * FROM cnf.claim_result"

const SelectAllFromClaimResultByClaimIDs = "SELECT * FROM cnf.claim_result WHERE claim_id IN (%s)"

const ServerAddrEnvVarErr = "SERVER_ADDR environment variable must be set"

const ServerEnvVarsError = "Error found while extracting environment variables related to the server: %s"

const ServerIsUpMsg = "Server is up"

const ServerReadTimeOutEnvVarErr = "SERVER_READ_TIMEOUT environment variable must be set"

const ServerWriteTimeOutEnvVarErr = "SERVER_WRITE_TIMEOUT environment variable must be set"

const SuccessUploadingFileMSG = "File was uploaded successfully!"

const TestIDIDMissingErr = "id subfield of %s's testID field is missing"

const TestIDSuiteMissingErr = "suite subfield of %s's testID field is missing"

const TestStateMissingErr = "state subfield of %s test is missing"

const TestTestIDMissingErr = "testID subfield of %s test is missing"

const UnmarshalErr = "Error found while trying to unmarshal claim file: %s"

const UseCollectorSQLCmd = `USE cnf; `

const VersionsFieldMissingErr = "versions field is missing"

const VersionsTag = "versions"

const WritingResponseErr = "Error found while writing response: %s"

Functions

func GetClaimFile

func GetClaimFile(w http.ResponseWriter, r *http.Request) multipart.File

func GetCollectorTablesByPartner

func GetCollectorTablesByPartner(db *sql.DB, partnerName string) (claimRows, claimResultsRows *sql.Rows)

func GetDatabaseEnvVars

func GetDatabaseEnvVars() (user, password, dbURL, port string)

func GetEntireCollectorTable

func GetEntireCollectorTable(db *sql.DB) (claimRows, claimResultsRows *sql.Rows)

func GetS3ConnectEnvVars

func GetS3ConnectEnvVars() (s3BucketName, region, accessKey, secretAccessKey string)

func GetServerEnvVars

func GetServerEnvVars() (readTimeOutInt, writeTimeOutInt int, addr, err string)

func HandleTransactionRollback

func HandleTransactionRollback(tx *sql.Tx)

func ReadClaimFile

func ReadClaimFile(w http.ResponseWriter, r *http.Request) ([]byte, error)

func StoreClaimFileInDatabase

func StoreClaimFileInDatabase(db *sql.DB, claimResult []types.ClaimResult, partnerName, executedBy, ocpVersion, s3FileKey string) error

This function stores the claim and claim result into the database in a transaction

func WriteMsg

func WriteMsg(w http.ResponseWriter, err string)

Writes Error or Msg using http response writer.