first commit

Author: bumu

LICENSE

@@ -1,21 +1,20 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2023 airdb
+Copyright (c) 2017 airdb.com
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,3 @@
 # toolbox
+
 Toolbox is a golang base common library

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

dbkit/Makefile

@@ -0,0 +1,27 @@
+SERVICE := redis
+
+up:
+	sudo docker-compose up -d --build --force-recreate
+build:
+	sudo docker-compose build --no-cache
+
+start:
+	sudo docker-compose start
+
+stop:
+	sudo docker-compose stop
+
+restart:
+	sudo docker-compose restart
+
+ps:
+	sudo docker-compose ps
+
+log logs:
+	sudo docker-compose logs
+
+rm: stop
+	sudo docker-compose rm ${SERVICE}
+
+bash:
+	sudo docker-compose exec ${SERVICE} bash

dbkit/dbutil.go

@@ -0,0 +1,157 @@
+package dbkit
+
+import (
+	"log"
+	"os"
+	"strings"
+	"sync"
+	"sync/atomic"
+	"time"
+
+	"gorm.io/driver/mysql"
+	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
+	"gorm.io/gorm/schema"
+)
+
+var (
+	dbs     sync.Map
+	hasInit int32
+	hasPend sync.Mutex
+)
+
+const (
+	DSNMainWrite   = "DSN_MAIN_WRITE"
+	DSNMainRead    = "DSN_MAIN_READ"
+	DSNSecondWrite = "DSN_SECOND_WRITE"
+	DSNSecondRead  = "DSN_SECOND_READ"
+)
+
+var DefaultDBs = []string{
+	DSNMainWrite,
+	DSNMainRead,
+	DSNSecondWrite,
+	DSNSecondRead,
+}
+
+func InitDefaultDB() {
+	InitDB(DefaultDBs)
+}
+
+func InitDB(dbNames []string) {
+	if atomic.LoadInt32(&hasInit) == 1 {
+		return
+	}
+
+	hasPend.Lock()
+	defer hasPend.Unlock()
+
+	for _, dbName := range dbNames {
+		conn := Connect(dbName)
+
+		if conn != nil {
+			dbs.Store(dbName, conn)
+		}
+	}
+
+	if atomic.LoadInt32(&hasInit) == 1 {
+		log.Println("concurrent_between_coroutines")
+
+		return
+	}
+
+	atomic.StoreInt32(&hasInit, 1)
+}
+
+func WriteDefaultDB() *gorm.DB {
+	return DB(DSNMainWrite)
+}
+
+func ReadDefaultDB() *gorm.DB {
+	return DB(DSNMainRead)
+}
+
+func WriteDB(name string) *gorm.DB {
+	return DB(name)
+}
+
+func ReadDB(name string) *gorm.DB {
+	return DB(name)
+}
+
+func DB(name string) (db *gorm.DB) {
+	_db, ok := dbs.Load(name)
+	if ok {
+		db = _db.(*gorm.DB)
+	}
+
+	if db == nil {
+		log.Printf("database %s is nil.\n", name)
+	}
+
+	return
+}
+
+const (
+	maxIdleConn = 2
+	maxOpenConn = 5
+)
+
+// Connection gets connection of mysql database
+func Connect(dbName string) (db *gorm.DB) {
+	dsn := os.Getenv(dbName)
+	if dsn == "" {
+		return nil
+	}
+
+	if !strings.Contains(dsn, "?") {
+		dsn += "?charset=utf8mb4&parseTime=True&loc=Local"
+	}
+
+	/*
+		newLogger := logger.New(
+			log.New(os.Stdout, "\r\n", log.LstdFlags), // io writer
+			logger.Config{
+				SlowThreshold: time.Second, // Slow SQL threshold
+				// LogLevel:      logger.Info, // Log level
+				LogLevel: logger.Silent, // Log level
+				Colorful: false,         // Disable color
+			},
+		)
+	*/
+
+	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
+		Logger: logger.Default.LogMode(logger.Info),
+		NamingStrategy: schema.NamingStrategy{
+			TablePrefix:   "tab_", // table name prefix, table for `User` would be `t_users`
+			SingularTable: true,   // use singular table name, table for `User` would be `user` with this option enabled
+		},
+	})
+	if err != nil {
+		log.Println(err)
+	}
+
+	sqlDB, _ := db.DB()
+
+	sqlDB.SetMaxIdleConns(maxIdleConn)
+	sqlDB.SetMaxOpenConns(maxOpenConn)
+	sqlDB.SetConnMaxLifetime(time.Hour)
+
+	return db
+}
+
+// InitTestDB will init the mock DB and lock the db so that the actual db will not be required.
+func InitTestDB(name string, db *gorm.DB) error {
+	if !atomic.CompareAndSwapInt32(&hasInit, 0, 1) {
+		return nil
+	}
+
+	dbs.Store(name, db)
+
+	return nil
+}
+
+// ReleaseTestDB is to release the lock for other unit tests to mock db successfully.
+func ReleaseTestDB() {
+	atomic.CompareAndSwapInt32(&hasInit, 1, 0)
+}

dbkit/dbutil_test.go

@@ -0,0 +1,40 @@
+package dbkit_test
+
+import (
+	"os"
+	"testing"
+
+	"github.com/airdb/toolbox/dbkit"
+	dbutil "github.com/airdb/toolbox/dbkit"
+)
+
+func TestInitDB(t *testing.T) {
+	if !testing.Short() {
+		t.Skip("skipping testing in short mode")
+	}
+
+	os.Setenv("DSN_MAIN_WRITE", "airdb:airdb@tcp(127.0.0.1:3306)/test")
+	os.Setenv("DSN_MAIN_READ", "airdb:airdb@tcp(127.0.0.1:3306)/test")
+
+	dbkit.InitDefaultDB()
+	var users []string
+	// select * from information_schema.user_privileges;
+
+	db := dbutil.WriteDB(dbutil.DSNMainWrite).Table("information_schema.user_privileges").
+		Select("GRANTEE").Distinct("GRANTEE").Find(&users).Debug()
+	if db.Error != nil {
+		panic(db.Error)
+	}
+
+	for _, user := range users {
+		t.Log("user: ", user)
+	}
+}
+
+/*
+	data := make(map[string]interface{})
+	data["user_id"] = 0
+	data["status"] = "ok"
+	data["updated_at"] = uint(time.Now().Unix())
+ 	db := tx.Updates(data)
+*/

dbkit/docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3'
+
+services:
+  redis:
+    platform: linux/amd64
+    image: 'redis'
+    #command: sleep 3600
+    command: redis-server --requirepass airdb
+    volumes:
+      - ./:/srv/redis/
+    ports:
+      - "6379:6379"
+    environment:
+      - REDIS_PORT_NUMBER=6379
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_PASSWORD=airdb
+    container_name: redis

dbkit/init.sql

@@ -0,0 +1,25 @@
+GRANT ALL PRIVILEGES ON *.* TO 'root' @'%';
+
+CREATE USER 'airdb'@'%' IDENTIFIED BY 'airdb';
+
+ALTER user 'airdb'@'%'IDENTIFIED BY 'airdb';
+
+GRANT ALL PRIVILEGES ON *.* TO 'airdb' @'%';
+
+GRANT ALL ON *.* TO 'airdb'@'%';
+
+FLUSH PRIVILEGES;
+
+CREATE DATABASE IF NOT EXISTS `test`;
+
+USE `test`;
+
+CREATE TABLE
+    IF NOT EXISTS `tab_user` (
+        `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+        `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        `updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+        `deleted_at` TIMESTAMP NULL DEFAULT NULL,
+        `user` varchar(512) COLLATE utf8mb4_unicode_ci NOT NULL,
+        PRIMARY KEY (`id`)
+    ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci;

dbkit/redis.go

@@ -0,0 +1,15 @@
+package dbkit
+
+import (
+	"log"
+
+	"github.com/go-redis/redis"
+)
+
+func NewRedisClient(opt *redis.Options) *redis.Client {
+	redisdb := redis.NewClient(opt)
+
+	log.Println("redis status:", redisdb.Ping())
+
+	return redisdb
+}

dbkit/redis_test.go

@@ -0,0 +1,22 @@
+package dbkit_test
+
+import (
+	"testing"
+
+	"github.com/airdb/toolbox/dbkit"
+	"github.com/go-redis/redis"
+)
+
+func TestNewRedisClient(t *testing.T) {
+	if !testing.Short() {
+		t.Skip("skipping testing in short mode")
+	}
+
+	opt := redis.Options{}
+	opt.Addr = "127.0.0.1:6379"
+	opt.DB = 2
+	opt.Password = "airdb"
+
+	redisdb := dbkit.NewRedisClient(&opt)
+	t.Log(redisdb.Ping())
+}

docker-compose.yml

@@ -0,0 +1,26 @@
+version: '3'
+
+services:
+  mysql:
+    image: mysql:latest
+    #command: --init-file /srv/sql/init.sql
+    command: --default-authentication-plugin=mysql_native_password
+    volumes:
+      - ./dbutil/init.sql:/docker-entrypoint-initdb.d/init.sql
+    ports:
+      - "3306:3306"
+    environment:
+      MYSQL_ROOT_HOST: '%'
+      MYSQL_DATABASE: test
+      MYSQL_USER: airdb
+      MYSQL_PASSWORD: airdb
+      MYSQL_RANDOM_ROOT_PASSWORD: "yes"
+    container_name: mysql
+
+  redis:
+    image: redis:6.2-alpine
+    restart: always
+    ports:
+      - '6379:6379'
+    command: redis-server --save 20 1 --loglevel warning --requirepass eYVX7EwVmmxKPCDmwMtyKVge8oLd2t81
+    container_name: redis