release: v0.1.0 (#5)

PedroChaparro · web-flow · commit f8b9abafa6f0 · 2024-01-05T21:08:45.000-05:00
* feat: Update submissions status in the database (#4) * feat: Connect to postgres and rabbitmq * feat: Implement submissions repository * feat: Listen for messages in the SSU queue and update entry in database * docs: Add Readme and contributing guidelines
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+# Temp files
+tmp/ 
+
+# Editor files
+.vscode/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+# 0.1.0 (2024-01-06)
+
+
+### Features
+
+* Update submissions status in the database ([#4](https://github.com/upb-code-labs/submissions-status-updater-microservice/issues/4)) ([fa0df88](https://github.com/upb-code-labs/submissions-status-updater-microservice/commit/fa0df883043022d38787e1640989b0d24d8b967e))
+
+
+
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# Submissions Status Updater micro-service
+
+Welcome to the Submissions Status Updater micro-service. This service is responsible for listening for messages in the `submission-status-updates` queue and updating the status of the submissions in the database and publishing the updated submissions to the `real-time-updates` queue.
+
+Below is a diagram of the overall architecture of the system with the Submissions Status Updater micro-service highlighted in green.
+
+![Submissions Status Updater microservice highlighted with a green rectangle in the overall architecture diagram](./docs/images/submissions-status-updater-microservice-highlighted.png)
+
+## Documentation
+
+Please, refer to the following documents for more information about the tests micro-service:
+
+| Document                               | Description                                                                 |
+| -------------------------------------- | --------------------------------------------------------------------------- |
+| [Contributing](./docs/contributing.md) | Contributing guidelines.                                                    |
+| [Environment](./docs/environment.md)   | A description of the environment variables used by the tests micro-service. |
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,54 @@
+# General organization contribution guidelines
+
+Please, read the [General Contribution Guidelines](https://github.com/upb-code-labs/docs/blob/main/CONTRIBUTING.md) before contributing.
+
+# Submissions Status Updater micro-service contribution guidelines
+
+## Project structure / architecture
+
+The Submissions Status Updater micro-service's architecture is based on the Hexagonal Architecture in order to make it easier to maintain and extend.
+
+The project structure is as follows:
+
+- `domain`: Contains the business logic of the Submissions Status Updater micro-service.
+
+  - `definitions`: Contains the interfaces (contracts) of the Submissions Status Updater micro-service.
+  - `entities`: Contains the entities of the Submissions Status Updater micro-service.
+  - `dtos`: Contains the data transfer objects of the Submissions Status Updater micro-service.
+
+- `application`: Contains the application logic (use cases) of the Submissions Status Updater micro-service.
+
+- `infrastructure`: Contains the implementation of the Submissions Status Updater micro-service's interfaces (contracts) and the external dependencies of the Submissions Status Updater micro-service.
+
+  - `implementations`: Contains the implementations of the `domain` interfaces (contracts).
+
+- `shared`: Contains the shared code of the Submissions Status Updater micro-service.
+
+  - `utils`: Contains the utility functions of the Submissions Status Updater micro-service.
+
+## Local development
+
+### Dependencies
+
+The following dependencies are required to run the Submissions Status Updater micro-service locally:
+
+- [Go 1.21.5](https://golang.org/doc/install)
+- [Podman](https://podman.io/getting-started/installation) (To build and test the container image)
+
+Please, note that `Podman` is a drop-in replacement for `Docker`, so you can use `Docker` instead if you prefer.
+
+Additionally, you may want to install the following dependencies to make your life easier:
+
+- [Air](https://github.com/cosmtrek/air) (for live reloading)
+
+### Running the Submissions Status Updater micro-service locally
+
+As the role of the Submissions Status Updater micro-service is to listen for messages in the `submission-status-updates` queue and update the status of the submissions in the database and publish the updated submissions to the `real-time-updates` queue, you will need to run the [gateway](https://github.com/UPB-Code-Labs/main-api) project first in order to initialize the queue, database, RabbitMQ and the other micro-services and then you can send submissions by using the REST API.
+
+After you have the gateway running, you can start the Submissions Status Updater micro-service by running the following command:
+
+```bash
+air
+```
+
+This will start the Submissions Status Updater micro-service and will watch for changes in the source code and restart the service automatically.
diff --git a/docs/environment.md b/docs/environment.md
@@ -0,0 +1,8 @@
+# Environment
+
+This document describes the required environment variables to run the micro-service.
+
+| Name                          | Description                                     | Example                                                             | Mandatory |
+| ----------------------------- | ----------------------------------------------- | ------------------------------------------------------------------- | --------- |
+| `RABBIT_MQ_CONNECTION_STRING` | The connection string to the RabbitMQ instance. | `amqp://username:password@address:port/`                            | Yes       |
+| `DB_CONNECTION_STRING`        | The connection string to the postgres database  | `postgres://username:password@domain:port/database?sslmode=disable` | Yes       |
diff --git a/docs/images/submissions-status-updater-microservice-highlighted.png b/docs/images/submissions-status-updater-microservice-highlighted.png
diff --git a/go.mod b/go.mod
@@ -3,6 +3,7 @@ module github.com/upb-code-labs/submissions-status-updater-microservice
 go 1.21.5
 
 require (
-	github.com/lib/pq v1.10.9 // indirect
-	github.com/rabbitmq/amqp091-go v1.9.0 // indirect
+	github.com/kelseyhightower/envconfig v1.4.0
+	github.com/lib/pq v1.10.9
+	github.com/rabbitmq/amqp091-go v1.9.0
 )
diff --git a/go.sum b/go.sum
@@ -1,5 +1,7 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
+github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -12,6 +14,7 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+go.uber.org/goleak v1.2.1 h1:NBol2c7O1ZokfZ0LEU9K6Whx/KnwvepVetCUhtKja4A=
 go.uber.org/goleak v1.2.1/go.mod h1:qlT2yGI9QafXHhZZLxlSuNsMw3FFLxBr+tBRlmO1xH4=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
diff --git a/main.go b/main.go
@@ -1,7 +1,24 @@
 package main
 
-import "fmt"
+import (
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/config"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/config/connections"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/infrastructure"
+)
 
 func main() {
-	fmt.Println("Implement me!")
+	// Parse environment variables
+	config.GetEnvironment()
+
+	// Connect to database
+	connections.GetPostgresConnection()
+	defer connections.ClosePostgresConnection()
+
+	// Connect to RabbitMQ
+	connections.GetRabbitMQChannel()
+	defer connections.CloseRabbitMQConnection()
+
+	// Listen for submission status updates
+	submissionStatusUpdatesQueueMgr := infrastructure.GetSubmissionStatusUpdatesQueueMgr()
+	submissionStatusUpdatesQueueMgr.ListenForSubmissionStatusUpdates()
 }
diff --git a/src/application/.gitkeep b/src/application/.gitkeep
diff --git a/src/application/submissions-status-updater-use-cases.go b/src/application/submissions-status-updater-use-cases.go
@@ -0,0 +1,24 @@
+package application
+
+import (
+	"log"
+
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/domain/definitions"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/domain/dtos"
+)
+
+type SubmissionsStatusUpdaterUseCases struct {
+	SubmissionsRepository definitions.SubmissionsRepository
+}
+
+func (useCases *SubmissionsStatusUpdaterUseCases) UpdateSubmissionStatus(dto *dtos.SubmissionStatusUpdateDTO) error {
+	// Update submission status in the database
+	err := useCases.SubmissionsRepository.UpdateSubmissionStatus(dto)
+	if err != nil {
+		log.Println("[SubmissionsStatusUpdaterUseCases] Error updating submission status: " + err.Error())
+		return err
+	}
+
+	// TODO: Send submission status update to the submissions real time updates queue
+	return nil
+}
diff --git a/src/config/connections/postgres-connection.go b/src/config/connections/postgres-connection.go
@@ -0,0 +1,39 @@
+package connections
+
+import (
+	"database/sql"
+	"log"
+
+	_ "github.com/lib/pq"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/config"
+)
+
+var pgConnection *sql.DB
+
+func GetPostgresConnection() *sql.DB {
+	if pgConnection == nil {
+		// Connect
+		pgConnectionString := config.GetEnvironment().DbConnectionString
+		db, err := sql.Open("postgres", pgConnectionString)
+		if err != nil {
+			log.Fatal(err.Error())
+		}
+
+		// Check connection
+		if err = db.Ping(); err != nil {
+			log.Fatal(err.Error())
+		}
+
+		// Set connection
+		log.Println("Connected to Postgres")
+		pgConnection = db
+	}
+
+	return pgConnection
+}
+
+func ClosePostgresConnection() {
+	if pgConnection != nil {
+		pgConnection.Close()
+	}
+}
diff --git a/src/config/connections/rabbitmq-connection.go b/src/config/connections/rabbitmq-connection.go
@@ -0,0 +1,43 @@
+package connections
+
+import (
+	"log"
+
+	amqp "github.com/rabbitmq/amqp091-go"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/config"
+)
+
+var rabbitMQChannel *amqp.Channel
+
+func ConnectToRabbitMQ() {
+	// Stablish connection
+	rabbitMQConnectionString := config.GetEnvironment().RabbitMQConnectionString
+	conn, err := amqp.Dial(rabbitMQConnectionString)
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+
+	// Get channel
+	ch, err := conn.Channel()
+	if err != nil {
+		log.Fatal(err.Error())
+	}
+
+	// Set channel
+	log.Println("[RabbitMQ]: Connected")
+	rabbitMQChannel = ch
+}
+
+func CloseRabbitMQConnection() {
+	if rabbitMQChannel != nil {
+		rabbitMQChannel.Close()
+	}
+}
+
+func GetRabbitMQChannel() *amqp.Channel {
+	if rabbitMQChannel == nil {
+		ConnectToRabbitMQ()
+	}
+
+	return rabbitMQChannel
+}
diff --git a/src/config/environment.go b/src/config/environment.go
@@ -0,0 +1,28 @@
+package config
+
+import (
+	"log"
+
+	"github.com/kelseyhightower/envconfig"
+)
+
+type EnvironmentSpec struct {
+	// Connection strings
+	DbConnectionString       string `split_words:"true" default:"postgres://postgres:postgres@localhost:5432/codelabs?sslmode=disable"`
+	RabbitMQConnectionString string `split_words:"true" default:"amqp://rabbitmq:rabbitmq@localhost:5672/"`
+}
+
+var environment *EnvironmentSpec
+
+func GetEnvironment() *EnvironmentSpec {
+	if environment == nil {
+		environment = &EnvironmentSpec{}
+
+		err := envconfig.Process("", environment)
+		if err != nil {
+			log.Fatal(err.Error())
+		}
+	}
+
+	return environment
+}
diff --git a/src/domain/definitions/.gitkeep b/src/domain/definitions/.gitkeep
diff --git a/src/domain/definitions/submissions_repository.go b/src/domain/definitions/submissions_repository.go
@@ -0,0 +1,7 @@
+package definitions
+
+import "github.com/upb-code-labs/submissions-status-updater-microservice/src/domain/dtos"
+
+type SubmissionsRepository interface {
+	UpdateSubmissionStatus(dto *dtos.SubmissionStatusUpdateDTO) error
+}
diff --git a/src/domain/dtos/.gitkeep b/src/domain/dtos/.gitkeep
diff --git a/src/domain/dtos/dtos.go b/src/domain/dtos/dtos.go
@@ -0,0 +1,8 @@
+package dtos
+
+type SubmissionStatusUpdateDTO struct {
+	SubmissionUUID   string `json:"submission_uuid"`
+	SubmissionStatus string `json:"submission_status"`
+	TestsPassed      bool   `json:"tests_passed"`
+	TestsOutput      string `json:"tests_output"`
+}
diff --git a/src/infrastructure/implementations/.gitkeep b/src/infrastructure/implementations/.gitkeep
diff --git a/src/infrastructure/implementations/submissions_pg_repository.go b/src/infrastructure/implementations/submissions_pg_repository.go
@@ -0,0 +1,55 @@
+package implementations
+
+import (
+	"context"
+	"database/sql"
+	"time"
+
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/config/connections"
+	"github.com/upb-code-labs/submissions-status-updater-microservice/src/domain/dtos"
+)
+
+type SubmissionsPgRepository struct {
+	Connection *sql.DB
+}
+
+// submissionsPgRepositoryInstance is a singleton of SubmissionsPgRepository
+var submissionsPgRepositoryInstance *SubmissionsPgRepository
+
+// GetSubmissionsPgRepository returns a singleton of SubmissionsPgRepository
+func GetSubmissionsPgRepository() *SubmissionsPgRepository {
+	if submissionsPgRepositoryInstance == nil {
+		submissionsPgRepositoryInstance = &SubmissionsPgRepository{
+			Connection: connections.GetPostgresConnection(),
+		}
+	}
+
+	return submissionsPgRepositoryInstance
+}
+
+// UpdateSubmissionStatus updates the status of a submission
+func (repo *SubmissionsPgRepository) UpdateSubmissionStatus(dto *dtos.SubmissionStatusUpdateDTO) error {
+	ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
+	defer cancel()
+
+	query := `
+		UPDATE submissions
+		SET status = $1, passing = $2, stdout = $3
+		WHERE id = $4
+	`
+
+	_, err := repo.Connection.ExecContext(
+		ctx,
+		query,
+		dto.SubmissionStatus,
+		dto.TestsPassed,
+		dto.TestsOutput,
+		dto.SubmissionUUID,
+	)
+
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
diff --git a/src/infrastructure/submission-status-updates-queue.go b/src/infrastructure/submission-status-updates-queue.go
diff --git a/version.json b/version.json

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ module github.com/upb-code-labs/submissions-status-updater-microservice`
`3`	`3`	`go 1.21.5`
`4`	`4`
`5`	`5`	`require (`
`6`		`- github.com/lib/pq v1.10.9 // indirect`
`7`		`- github.com/rabbitmq/amqp091-go v1.9.0 // indirect`
	`6`	`+ github.com/kelseyhightower/envconfig v1.4.0`
	`7`	`+ github.com/lib/pq v1.10.9`
	`8`	`+ github.com/rabbitmq/amqp091-go v1.9.0`
`8`	`9`	`)`