Merge pull request #104 from NUAA-Open-Source/dev

Go public!

Author: arcosx

.github/workflows/go.yml

@@ -0,0 +1,28 @@
+name: Go
+on: [push, pull_request]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Set up Go 1.12
+      uses: actions/setup-go@v1
+      with:
+        go-version: 1.12
+      id: go
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v1
+
+    - name: Get dependencies
+      run: |
+        go get -v -t -d ./...
+        if [ -f Gopkg.toml ]; then
+            curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
+            dep ensure
+        fi
+
+    - name: Build
+      run: go build -v .

ERRORS.md

@@ -60,4 +60,5 @@
 
 | Error Code | Error Message (en) | Error Message (zh) |
 | :----: | :----: | :----: |
-| 20501 | Incorrect password | 密码错误 |
+| 20501 | Password incorrect | 密码错误 |
+| 20502 | Password required | 需要密码 |

README.md

@@ -55,6 +55,7 @@
     "Database": "safeu",
     "MaxIdleConns": 30,
     "MaxOpenConns": 100,
+    "ConnMaxLifetime": 3600,
     "Debug": false
   },
   "Redis": {
@@ -120,7 +121,7 @@ Cross-site Request Forgery 跨域请求伪造防护设计。
 ### Build from Source
 
 ```bash
-$ git clone https://github.com/Triple-Z/safeu-backend.git
+$ git clone https://github.com/NUAA-Open-Source/safeu-backend.git
 $ cd safeu-backend/
 $ go get -u github.com/kardianos/govendor
 $ govendor sync
@@ -129,6 +130,15 @@ $ go run main.go
 
 > 要事先做好数据库的建立和配置。
 
+2019.9.1 Update: 支持了 `gomod` 作为依赖管理，可以直接使用 `go build` 直接构建：
+
+```bash
+$ git clone https://github.com/NUAA-Open-Source/safeu-backend.git
+$ cd safeu-backend/
+$ go build
+$ ./safeu-backend
+```
+
 ### Run via Docker
 
 通过 Docker 容器来运行应用。
@@ -206,16 +216,20 @@ $ ./prod-docker-compose.sh up
 
 ## Code of Conducts
 
+TBD.
+
 ## API Documentation
 
 API 文档位于 `api/` 文件夹下，采用 [OpenAPI 3.0.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) 标准编写。
-
+size
 Online Documentation: https://app.swaggerhub.com/apis-docs/a2os/safeu
 
 > 更多信息见 [SafeU 内部文档](https://docs.google.com/document/d/1UiFHogsqDSqw3SrEAnEMukOoJq3fyxqIIEP-OE7ask0/edit?ts=5c56f70d) **需要权限**。
 
 ## Development Workflow
 
+TBD.
+
 ## License
 
 该项目采用 [`Apache 2.0`](LICENSE) 许可证。
@@ -235,3 +249,4 @@ Online Documentation: https://app.swaggerhub.com/apis-docs/a2os/safeu
    See the License for the specific language governing permissions and
    limitations under the License.
 ```
+$ ./dev-docker-compose.sh up

common/const.go

@@ -3,7 +3,7 @@ package common
 var CloudConfig *CloudConfiguration
 
 const (
-	DEBUG       = false
+	DEBUG       = true
 	MAINTENANCE = false
 	PORT        = "8080"
 )

common/database.go

@@ -13,14 +13,15 @@ import (
 )
 
 type Db struct {
-	User         string
-	Pass         string
-	Host         string
-	Port         string
-	Database     string
-	MaxIdleConns int
-	MaxOpenConns int
-	Debug        bool
+	User            string
+	Pass            string
+	Host            string
+	Port            string
+	Database        string
+	MaxIdleConns    int
+	MaxOpenConns    int
+	ConnMaxLifetime int
+	Debug           bool
 }
 
 type RedisDb struct {
@@ -66,7 +67,7 @@ func InitDB() *gorm.DB {
 		db *gorm.DB
 		e  error
 	)
-	connectString := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&collation=utf8mb4_bin&parseTime=True&loc=%s", DBConf.Master.User, DBConf.Master.Pass, DBConf.Master.Host, DBConf.Master.Port, DBConf.Master.Database, MYSQLTIMEZONE)
+	connectString := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&collation=utf8mb4_bin&parseTime=True&loc=%s&timeout=10s", DBConf.Master.User, DBConf.Master.Pass, DBConf.Master.Host, DBConf.Master.Port, DBConf.Master.Database, MYSQLTIMEZONE)
 	// 重试连接
 	for db, e = gorm.Open("mysql", connectString); e != nil; {
 		fmt.Println("Gorm Open DB Err: ", e)
@@ -76,11 +77,19 @@ func InitDB() *gorm.DB {
 
 	log.Println("Connected to database ", DBConf.Master.User, " ", DBConf.Master.Pass, " ", DBConf.Master.Host, ":", DBConf.Master.Port, " ", DBConf.Master.Database)
 	db.DB().SetMaxIdleConns(DBConf.Master.MaxIdleConns)
+	db.DB().SetMaxOpenConns(DBConf.Master.MaxOpenConns)
+	db.DB().SetConnMaxLifetime(time.Duration(DBConf.Master.ConnMaxLifetime) * time.Second)
 	DB = db
+	DB.LogMode(true)
 	return DB
 }
 
 func GetDB() *gorm.DB {
+	// Ping
+	err := DB.DB().Ping()
+	if err != nil {
+		log.Println("Cannot access the database (PING FAILED)")
+	}
 	return DB
 }
 

common/error.go

@@ -162,5 +162,6 @@ var Errors = map[int]string{
 	20306: "The retrieve code mismatch auth",
 	20307: "The retrieve code repeat",
 
-	20501: "Incorrect password",
+	20501: "Password incorrect",
+	20502: "Password required",
 }

conf/db.example.json

@@ -3,15 +3,16 @@
     "User": "your_db_username",
     "Pass": "your_db_password",
     "Host": "your_db_ip_address",
-    "Port": "3306",
+    "Port": "your_db_port",
     "Database": "safeu",
     "MaxIdleConns": 30,
     "MaxOpenConns": 100,
+    "ConnMaxLifetime":3600,
     "Debug": false
   },
   "Redis": {
-    "Host": "safeu-redis",
-    "Port": "6379",
-    "Pass": ""
+    "Host": "your_redis_ip_address",
+    "Port": "your_redis_port",
+    "Pass": "your_redis_password"
   }
 }

conf/redis/redis.conf

@@ -1,16 +1,16 @@
-notify-keyspace-events "Ex"
-# requirepass "safeu"
-save 60 100
-save 900 1
-save 300 10
-stop-writes-on-bgsave-error no
-rdbcompression yes
-dbfilename dump.rdb
-
-appendonly no
-appendfsync everysec
-no-appendfsync-on-rewrite no
-auto-aof-rewrite-percentage 100
-auto-aof-rewrite-min-size 64mb
-
-dir /data
+notify-keyspace-events "Ex"
+# requirepass "safeu"
+save 60 100
+save 900 1
+save 300 10
+stop-writes-on-bgsave-error no
+rdbcompression yes
+dbfilename dump.rdb
+
+appendonly no
+appendfsync everysec
+no-appendfsync-on-rewrite no
+auto-aof-rewrite-percentage 100
+auto-aof-rewrite-min-size 64mb
+
+dir /data

deployments/dev-safeu/docker-compose.yml

@@ -28,9 +28,9 @@ services:
       - "9000:8080"
     networks:
       - safeu-app-net
-    depends_on:
+    # depends_on:
 #      - db
-      - safeu-redis
+      # - safeu-redis
     restart: always
 
 #  db:
@@ -48,20 +48,20 @@ services:
 #    networks:
 #      - safeu-app-net
 #    restart: on-failure
-    
-  safeu-redis:
-    image: redis:5.0.3-alpine
-    environment:
-      - TZ=Asia/Shanghai
-    volumes:
-      - ../../conf/redis/redis.conf:/usr/local/etc/redis/redis.conf
-      - ../../data-dev/redis:/data # for redis persistent storage
-    entrypoint: redis-server /usr/local/etc/redis/redis.conf
-    ports:
-      - "6379:6379"
-    networks:
-      - safeu-app-net
-    restart: on-failure
+
+  # safeu-redis:
+  #   image: redis:5.0.3-alpine
+  #   environment:
+  #     - TZ=Asia/Shanghai
+  #   volumes:
+  #     - ../../conf/redis/redis.conf:/usr/local/etc/redis/redis.conf
+  #     - ../../data-dev/redis:/data # for redis persistent storage
+  #   entrypoint: redis-server /usr/local/etc/redis/redis.conf
+  #   ports:
+  #     - "6379:6379"
+  #   networks:
+  #     - safeu-app-net
+  #   restart: on-failure
 
 networks:
   safeu-app-net:

deployments/prod-safeu/docker-compose.yml

@@ -30,8 +30,8 @@ services:
       - "8080:8080"
     networks:
       - safeu-app-net
-    depends_on:
-      - safeu-redis
+    # depends_on:
+    #   - safeu-redis
     restart: on-failure
 
   safeu2:
@@ -47,8 +47,8 @@ services:
       - "8081:8080"
     networks:
       - safeu-app-net
-    depends_on:
-      - safeu-redis
+    # depends_on:
+    #   - safeu-redis
     restart: on-failure
 
   safeu3:
@@ -64,8 +64,8 @@ services:
       - "8082:8080"
     networks:
       - safeu-app-net
-    depends_on:
-      - safeu-redis
+    # depends_on:
+    #   - safeu-redis
     restart: on-failure
 
 #  db:
@@ -82,19 +82,19 @@ services:
 #    networks:
 #      - dbnet
 #    restart: on-failure
-  safeu-redis:
-    image: redis:5.0.3-alpine
-    environment:
-      - TZ=Asia/Shanghai
-    volumes:
-      - ../../conf/redis/redis.conf:/usr/local/etc/redis/redis.conf
-      - ../../data/redis:/data # for redis persistent storage
-    entrypoint: redis-server /usr/local/etc/redis/redis.conf
-    ports:
-      - "6379:6379"
-    networks:
-      - safeu-app-net
-    restart: on-failure
+  # safeu-redis:
+  #   image: redis:5.0.3-alpine
+  #   environment:
+  #     - TZ=Asia/Shanghai
+  #   volumes:
+  #     - ../../conf/redis/redis.conf:/usr/local/etc/redis/redis.conf
+  #     - ../../data/redis:/data # for redis persistent storage
+  #   entrypoint: redis-server /usr/local/etc/redis/redis.conf
+  #   ports:
+  #     - "6379:6379"
+  #   networks:
+  #     - safeu-app-net
+  #   restart: on-failure
 
 networks:
   safeu-app-net: