[Release] Liquibase Migration Tooling Added

* Liquibase migration tooling and scripts added.
* General code base maintenance.
* Redis cluster Docker configuration simplified.
* Redis cluster nodes canonical node names added.

docker-compose.yaml

@@ -24,7 +24,7 @@ services:
 
   redis-node-0:
     container_name: redis-node-0
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
       - '6379:6379'
@@ -33,7 +33,6 @@ services:
     environment:
       - 'REDIS_PASSWORD=root'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
-    command: ["redis-server", "--bind", "redis", "--port", "6379"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s
@@ -42,16 +41,15 @@ services:
 
   redis-node-1:
     container_name: redis-node-1
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
-      - '6380:6380'
+      - '6380:6379'
     volumes:
       - redis-cluster_data-1:/bitnami/redis/data
     environment:
       - 'REDIS_PASSWORD=root'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
-    command: ["redis-server", "--bind", "redis", "--port", "6380"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s
@@ -60,16 +58,15 @@ services:
 
   redis-node-2:
     container_name: redis-node-2
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
-      - '6381:6381'
+      - '6381:6379'
     volumes:
       - redis-cluster_data-2:/bitnami/redis/data
     environment:
       - 'REDIS_PASSWORD=root'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
-    command: ["redis-server", "--bind", "redis", "--port", "6381"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s
@@ -78,16 +75,15 @@ services:
 
   redis-node-3:
     container_name: redis-node-3
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
-      - '6382:6382'
+      - '6382:6379'
     volumes:
       - redis-cluster_data-3:/bitnami/redis/data
     environment:
       - 'REDIS_PASSWORD=root'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
-    command: ["redis-server", "--bind", "redis", "--port", "6382"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s
@@ -96,16 +92,15 @@ services:
 
   redis-node-4:
     container_name: redis-node-4
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
-      - '6383:6383'
+      - '6383:6379'
     volumes:
       - redis-cluster_data-4:/bitnami/redis/data
     environment:
       - 'REDIS_PASSWORD=root'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
-    command: ["redis-server", "--bind", "redis", "--port", "6383"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s
@@ -114,10 +109,10 @@ services:
 
   redis-node-5:
     container_name: redis-node-5
-    image: docker.io/bitnami/redis-cluster:latest
+    image: docker.io/bitnami/redis-cluster:7.0
     restart: always
     ports:
-      - '6384:6384'
+      - '6384:6379'
     volumes:
       - redis-cluster_data-5:/bitnami/redis/data
     depends_on:
@@ -132,7 +127,6 @@ services:
       - 'REDIS_CLUSTER_REPLICAS=1'
       - 'REDIS_NODES=redis-node-0 redis-node-1 redis-node-2 redis-node-3 redis-node-4 redis-node-5'
       - 'REDIS_CLUSTER_CREATOR=yes'
-    command: ["redis-server", "--bind", "redis", "--port", "6384"]
     healthcheck:
       test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]
       interval: 15s

docs/swagger.json

@@ -21,7 +21,7 @@
             "name": "GPL-3.0",
             "url": "https://opensource.org/licenses/GPL-3.0"
         },
-        "version": "1.6.2"
+        "version": "1.7.0"
     },
     "host": "localhost:44243",
     "basePath": "/api/rest/v1",

docs/swagger.yaml

@@ -211,7 +211,7 @@ info:
     name: GPL-3.0
     url: https://opensource.org/licenses/GPL-3.0
   title: Multiple Choice Question Platform.
-  version: 1.6.2
+  version: 1.7.0
 paths:
   /health:
     get:

pkg/cassandra/cassandra_queries_test.go

@@ -2,7 +2,6 @@ package cassandra
 
 import (
 	"fmt"
-	"math"
 	"net/http"
 	"reflect"
 	"testing"
@@ -554,7 +553,7 @@ func TestReadResponseStatisticsPageQuery(t *testing.T) {
 			}
 
 			// Iterate over all pages and tally up the total records retrieved.
-			expectedPageCount := int(math.Ceil(float64(testCase.expectedRecordCount / testCase.request.PageSize)))
+			expectedPageCount := testCase.expectedRecordCount / testCase.request.PageSize
 			pageCount := 0
 			recordCount := 0
 			request := &model_cassandra.StatsRequest{

pkg/http/graph/graph.go

@@ -79,7 +79,7 @@ func (s *Server) Run() {
 	}()
 
 	// Wait for interrupt signal to gracefully shut down the server.
-	quit := make(chan os.Signal)
+	quit := make(chan os.Signal, 1)
 	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
 
 	// Wait for interrupt.

pkg/http/graph/resolvers/authorization.go

@@ -9,9 +9,11 @@ import (
 	"github.com/surahman/mcq-platform/pkg/logger"
 )
 
+type GinContextKey struct{}
+
 // GinContextFromContext will extract the Gin context from the context passed in.
 func GinContextFromContext(ctx context.Context, logger *logger.Logger) (*gin.Context, error) {
-	ctxValue := ctx.Value("GinContextKey")
+	ctxValue := ctx.Value(GinContextKey{})
 	if ctxValue == nil {
 		logger.Error("could not retrieve gin.Context")
 		return nil, errors.New("malformed request: authorization information not found")

pkg/http/graph/resolvers/authorization_test.go

@@ -30,11 +30,11 @@ func TestGinContextFromContext(t *testing.T) {
 			name:        "incorrect context",
 			expectedMsg: "information malformed",
 			expectErr:   require.Error,
-			ctx:         context.WithValue(context.TODO(), "GinContextKey", context.TODO()),
+			ctx:         context.WithValue(context.TODO(), GinContextKey{}, context.TODO()),
 		}, {
 			name:      "success",
 			expectErr: require.NoError,
-			ctx:       context.WithValue(context.TODO(), "GinContextKey", &gin.Context{}),
+			ctx:       context.WithValue(context.TODO(), GinContextKey{}, &gin.Context{}),
 		},
 		// ----- test cases end ----- //
 	}
@@ -82,7 +82,7 @@ func TestAuthorizationCheck(t *testing.T) {
 			name:        "incorrect context",
 			expectedMsg: "information malformed",
 			expectErr:   require.Error,
-			ctx:         context.WithValue(context.TODO(), "GinContextKey", context.TODO()),
+			ctx:         context.WithValue(context.TODO(), GinContextKey{}, context.TODO()),
 			authValidateJWTData: &http_common.MockAuthData{
 				OutputParam1: "",
 				OutputParam2: int64(-1),
@@ -93,7 +93,7 @@ func TestAuthorizationCheck(t *testing.T) {
 			name:        "no token",
 			expectedMsg: "does not contain",
 			expectErr:   require.Error,
-			ctx:         context.WithValue(context.TODO(), "GinContextKey", ginCtxNoAuth),
+			ctx:         context.WithValue(context.TODO(), GinContextKey{}, ginCtxNoAuth),
 			authValidateJWTData: &http_common.MockAuthData{
 				OutputParam1: "",
 				OutputParam2: int64(-1),
@@ -104,7 +104,7 @@ func TestAuthorizationCheck(t *testing.T) {
 			name:        "no token",
 			expectedMsg: "failed to authenticate token",
 			expectErr:   require.Error,
-			ctx:         context.WithValue(context.TODO(), "GinContextKey", ginCtxAuth),
+			ctx:         context.WithValue(context.TODO(), GinContextKey{}, ginCtxAuth),
 			authValidateJWTData: &http_common.MockAuthData{
 				OutputParam1: "",
 				OutputParam2: int64(-1),
@@ -114,7 +114,7 @@ func TestAuthorizationCheck(t *testing.T) {
 		}, {
 			name:      "success",
 			expectErr: require.NoError,
-			ctx:       context.WithValue(context.TODO(), "GinContextKey", ginCtxAuth),
+			ctx:       context.WithValue(context.TODO(), GinContextKey{}, ginCtxAuth),
 			authValidateJWTData: &http_common.MockAuthData{
 				OutputParam1: "successful token refresh",
 				OutputParam2: int64(999),

pkg/http/graph/resolvers/handlers.go

@@ -48,7 +48,7 @@ func PlaygroundHandler(baseURL, queryURL string) gin.HandlerFunc {
 // GinContextToContextMiddleware is middleware that will place the Gin context into a context for the GraphQL resolvers.
 func GinContextToContextMiddleware() gin.HandlerFunc {
 	return func(c *gin.Context) {
-		ctx := context.WithValue(c.Request.Context(), "GinContextKey", c)
+		ctx := context.WithValue(c.Request.Context(), GinContextKey{}, c)
 		c.Request = c.Request.WithContext(ctx)
 		c.Next()
 	}

pkg/http/rest/rest.go

@@ -82,7 +82,7 @@ func (s *Server) Run() {
 	}()
 
 	// Wait for interrupt signal to gracefully shut down the server.
-	quit := make(chan os.Signal)
+	quit := make(chan os.Signal, 1)
 	signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
 
 	// Wait for interrupt.
@@ -105,7 +105,7 @@ func (s *Server) initialize() {
 	s.router = gin.Default()
 
 	//	@title						Multiple Choice Question Platform.
-	//	@version					1.6.2
+	//	@version					1.7.0
 	//	@description				Multiple Choice Question Platform API.
 	//	@description				This application supports the creation, managing, marking, viewing, retrieving stats, and scores of quizzes.
 	//

pkg/logger/logger.go

@@ -39,10 +39,8 @@ func (l *Logger) Init(fs *afero.Fs) (err error) {
 	switch strings.ToLower(userConfig.BuiltinConfig) {
 	case "development":
 		baseConfig = zap.NewDevelopmentConfig()
-		break
 	case "production":
 		baseConfig = zap.NewProductionConfig()
-		break
 	default:
 		msg := "could not select the base configuration type"
 		log.Println(msg)
@@ -53,10 +51,8 @@ func (l *Logger) Init(fs *afero.Fs) (err error) {
 	switch strings.ToLower(userConfig.BuiltinEncoderConfig) {
 	case "development":
 		encConfig = zap.NewDevelopmentEncoderConfig()
-		break
 	case "production":
 		encConfig = zap.NewProductionEncoderConfig()
-		break
 	default:
 		msg := "could not select the base encoder configuration type"
 		log.Println(msg)

pkg/model/cassandra/README.md

@@ -17,6 +17,7 @@
   - [Responses](#responses)
   - [CQL Query](#cql-query)
 - [Schema Migration and Setup](#schema-migration-and-setup)
+  - [Liquibase Migration](#liquibase-migration)
 
 <br/>
 
@@ -160,3 +161,51 @@ to be deployed in the following order:
 1. [user.cql](user.cql)
 2. [quiz.cql](quiz.cql)
 3. [responses.cql](responses.cql)
+
+This can be achieved manually or through tooling such as [Liquibase](https://www.liquibase.com/) which is the industry
+standard for database migrations.
+
+### Liquibase Migration
+For convenience, a Liquibase database schema migration change set has been provided with stages for rollbacks. 
+
+Please ensure you have the following installed in the `lib` directory of your Liquibase installation:
+* [Liquibase Cassandra Plugin](https://github.com/liquibase/liquibase-cassandra)
+* [Datastax JDBC Driver for Apache Cassandra](https://downloads.datastax.com/#odbc-jdbc-drivers)
+
+The [properties file](liquibase.properties) with the login credentials for the Cassandra cluster will need to be
+updated appropriately.
+
+```text
+changeLogFile: cassandra_migration.sql
+url: jdbc:cassandra://localhost:9042/mcq_platform;DefaultKeyspace=mcq_platform;AuthMech=1
+username: admin
+password: root
+driver: com.simba.cassandra.jdbc42.Driver
+defaultSchemaName: mcq_platform
+```
+
+The following key space will need to be manually created in your Cassandra cluster before the migration can be executed:
+
+```cql
+CREATE KEYSPACE IF NOT EXISTS mcq_platform WITH replication = {'class' : 'SimpleStrategy', 'replication_factor' : 3};
+```
+
+If you are running a single-node cluster for testing you will need to set the `replication_factor` to `1`.
+
+At this point a test should be run to ensure Liquibase is able to connect to the database:
+
+```bash
+liquibase status
+```
+
+If a connection could be established, you should be ready to execute a migration:
+
+```bash
+liquibase update
+```
+
+Verification of the changes can be achieved through:
+
+```bash
+liquibase history
+```