helper

README

go-helper

Under development

Package croonix/go-helper help in the development of Go applications by providing some useful functions.

Usage

To use, only import as helper and use it:

package main

import (
	"fmt"

	helper "github.com/croonix/go-helper"
)

...

Tasks

• Add Test files

Documentation

Overview

This module contains helper functions primary focused on Google Cloud Platform

Index

• Constants
• func AddServiceAccountUserRole(impersonateAccount string, targetAccount string, principalAccount string) error
• func BadRequest(c *gin.Context, message string)
• func CatMode(r *http.Request)
• func CheckBody(w http.ResponseWriter, r *http.Request)
• func ConnectCloudSQL(database string) *sql.DB
• func ConvertToBoolPointer(value interface{}) *bool
• func GetFavicon(w http.ResponseWriter, r *http.Request)
• func GetProjectFromServiceAccount(serviceAccount string) string
• func GormDatabase(databaseName string) *gorm.DB
• func HealthCheck(w http.ResponseWriter, r *http.Request)
• func ImpersonateSA(context context.Context, serviceAccount string, scope string) (token oauth2.TokenSource, err error)
• func List2String(values []string) string
• func Logger(message string, level string)
• func MessageHelper(w http.ResponseWriter, message string)
• func MustGetenv(k string) string
• func RemoveServiceAccountUserRole(impersonateAccount string, targetAccount string, principalAccount string) error
• func ResponseMessage(ctx *gin.Context, code int, message ...string)
• func UndefinedAnswer(w http.ResponseWriter, r *http.Request)
• func WrongParameter(w http.ResponseWriter, r *http.Request)
• func WrongPath() http.Handler
• type Message
• type TimestampSerializer
  • func (TimestampSerializer) Scan(ctx context.Context, field *schema.Field, dst reflect.Value, ...) (err error)
  • func (TimestampSerializer) Value(ctx context.Context, field *schema.Field, dst reflect.Value, ...) (interface{}, error)

Constants

const WrongMessage = "What are you doing here?"

Functions

func AddServiceAccountUserRole

func AddServiceAccountUserRole(impersonateAccount string, targetAccount string, principalAccount string) error

func BadRequest

func BadRequest(c *gin.Context, message string)

BadRequest is a simple function that returns a bad request message in JSON format with a BadRequest status code for Gin

func CatMode

func CatMode(r *http.Request)

CatMode is a function that will print the request information It will print the URL, Method, Headers and Body of the request It is used to debug the request information

func CheckBody

func CheckBody(w http.ResponseWriter, r *http.Request)

CheckBody is a function that will print the request information It will print the URL, Method, Headers and Body of the request It is used to debug the request information Needs to be used with io.TeeReader to be able to read the body multiple times Example:

• http.HandleFunc("/", CheckBody)

Output:

• Request information:
• Request URL: /?test=1
• Request Method: GET
• Request Headers: map[Accept:[*/*] Accept-Encoding:[gzip] User-Agent:Go-http-client/1.1]
• Request Body: test=1

func ConnectCloudSQL

func ConnectCloudSQL(database string) *sql.DB

func ConvertToBoolPointer

func ConvertToBoolPointer(value interface{}) *bool

ConvertToBoolPointer is a simple function that converts a interface to a *bool

func GetFavicon

func GetFavicon(w http.ResponseWriter, r *http.Request)

func GetProjectFromServiceAccount

func GetProjectFromServiceAccount(serviceAccount string) string

func GormDatabase

func GormDatabase(databaseName string) *gorm.DB

GormDatabase is a function that returns a GORM database connection - Use simple Structure to connect to the database - Use the following environment variables:

• DATABASE_USER
• DATABASE_PASS
• DATABASE_IP

Works only with MySQL databases (for now)

func HealthCheck

func HealthCheck(w http.ResponseWriter, r *http.Request)

func ImpersonateSA

func ImpersonateSA(context context.Context, serviceAccount string, scope string) (token oauth2.TokenSource, err error)

func List2String

func List2String(values []string) string

List2String converts a list of strings to a string in the format ["value1","value2"]

func Logger

func Logger(message string, level string)

func MessageHelper

func MessageHelper(w http.ResponseWriter, message string)

func MustGetenv

func MustGetenv(k string) string

MustGetenv validates if the environment variable is set and returns it otherwise it will log a fatal error and exit the program It is used to validate the environment variables Example:

• os.Setenv("TEST", "test")
• log.Println(MustGetenv("TEST"))
• log.Println(MustGetenv("TEST2"))

Output:

• test
• 2021/08/31 11:30:00 Missing environment variable: TEST2
• exit status 1

func RemoveServiceAccountUserRole

func RemoveServiceAccountUserRole(impersonateAccount string, targetAccount string, principalAccount string) error

func ResponseMessage

func ResponseMessage(ctx *gin.Context, code int, message ...string)

ResponseMessage is a simple function that returns a message in JSON format with a status code for Gin

func UndefinedAnswer

func UndefinedAnswer(w http.ResponseWriter, r *http.Request)

func WrongParameter

func WrongParameter(w http.ResponseWriter, r *http.Request)

func WrongPath

func WrongPath() http.Handler

Types

type Message

type Message struct {
	Message string `json:"message"`
}

type TimestampSerializer

type TimestampSerializer struct {
}

TimestampSerializer is a custom serializer for GORM to handle timestamps values

func (TimestampSerializer) Scan

func (TimestampSerializer) Scan(ctx context.Context, field *schema.Field, dst reflect.Value, dbValue interface{}) (err error)

func (TimestampSerializer) Value

func (TimestampSerializer) Value(ctx context.Context, field *schema.Field, dst reflect.Value, fieldValue interface{}) (interface{}, error)

Value implements serializer interface