Merge pull request #145 from ContainerMaintainers/development

Report release

Author: adamjhr

.github/workflows/Automated-Testing.yml

@@ -4,13 +4,11 @@ on:
   push:
     branches:
       - development
-  workflow_run:
-    workflows:
-      - "Automated Testing"
-    types:
-      - completed
+      - main
+  pull_request:
     branches:
       - development
+      - main
 
 jobs:
   cypress-test:
@@ -39,3 +37,43 @@ jobs:
         uses: cypress-io/github-action@v5.5.1
         with:
           wait-on: 'http://localhost:8080'
+
+  sim-api-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+    
+
+      - name: Create .env
+        run: |
+          touch .env
+          echo SESSION_KEY="${{ secrets.SESSION_KEY }}" >> .env
+          echo GIN_MODE="${{ vars.GIN_MODE }}" >> .env
+          echo PORT="${{ vars.PORT }}" >> .env
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.19
+        
+      - name: Run minitwit
+        run: go run minitwit.go -t &
+        
+      - name: Sleep for 2 minutes
+        run: sleep 2m
+        shell: bash
+        
+      - name: Install test dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+    
+      - name: Site Health Check
+        uses: pchalupa/site-health-check@v1.0.2
+        with:
+          url: 'http://127.0.0.1:8080/'
+
+      - name: Run pytest
+        run: pytest minitwit_sim_api_test.py

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Branching
+There are 2 default branches, one for each environment; `development`
+for the `development` environment and `main` for the `production` environment.
+
+The development branch is for testing our code. Here is where every newly developed feature is
+merged into as per default when creating a pull requests. This is also where we would discover if any
+new features were to introduce unforeseen bugs. It is also the branch that every new feature should
+branch out of.
+
+The main branch is our production environment. This is our ”live” code and is what the current
+state of our product looks like. This is also to define what is ready to use for our users.
+Whenever a new feature is to be initiated, this should happen in a new branch. This new branch
+should be named after the new feature. Following this naming convention allows other developers to
+keep a track of what each branch is for.
+
+# Workflow
+A centralized workflow is to be used for this project.
+
+# Reviewing
+There must be at least 1 `approved` review for each pull request. The reviewer must not have contributed to the pull request. Once the pull request has been approved, the branch gets merged into the `development` branch

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ContainerMaintainers
+
+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.

README.md

@@ -2,6 +2,12 @@
 
 A Golang Gin refactor of the minitwit application.
 
+## Before running the application
+
+Make sure docker is installed as well as docker compose.
+Furthermore, the docker drive for loki is also required. It can be installed via:
+`docker plugin install grafana/loki-docker-driver:latest --alias loki --grant-all-permissions`
+
 ## How to run the application
 
 1. Clone the repo

SLA.md

@@ -0,0 +1,35 @@
+This Service Level Agreement ("SLA") is entered into by and between Minitwit ("the Service Provider") and the customer ("the Customer").
+
+# Scope
+This SLA applies to the Minitwit web-service provided by the Service Provider to the Customer.
+
+# Definitions
+- Downtime: Defined as the time where the Minitwit service returns a status code 500.
+- Uptime: Defined as the time where the Minitwit service is operational and not experiencing downtime.
+- External Factors: Defined as events outside of the Service Provider's control, including but not limited to, acts of nature, acts of terrorism, power failures, or Internet connectivity issues.
+- Scheduled Downtime: Any planned maintenance or upgrades to the Minitwit service that are communicated to the Customer at least 72 hours in advance via email or other forms of electronic communication.
+
+# Service Level Objective
+The Service Provider guarantees 90% uptime per month for the Minitwit web-service.
+
+# Remedy for Service Failure
+If the Service Provider fails to meet the Service Level Objective during any given month, the Customer is entitled to a full refund for that month.
+
+# Exclusions
+This SLA does not apply in the event of downtime induced by External Factors or Scheduled Downtime.
+
+# Service Availability Monitoring
+The Service Provider will monitor the availability of the Minitwit service 24 hours a day, 7 days a week.
+
+# Availability Reports
+The Service Provider will provide monthly uptime and downtime reports to the Customer.
+
+# Modification of SLA
+The Service Provider reserves the right to modify this SLA at any time. The Customer will be notified of any changes to this SLA.
+
+# Termination
+The Customer may terminate this SLA if the Service Provider fails to meet the Service Level Objective for three consecutive months.
+
+# Governing Law
+This SLA shall be governed by and construed in accordance with the laws of the jurisdiction where the Service Provider is located.
+

controllers/timeline_controller.go

@@ -8,45 +8,48 @@ import (
 )
 
 // ENDPOINT: GET /
-func Timeline(c *gin.Context) {
+func IndexTimeline(c *gin.Context) {
+	page := c.DefaultQuery("page", "0")
 
-	// if there is NO session user, show public timeline
 	if user == -1 {
 		c.HTML(http.StatusOK, "timeline.html", gin.H{
-			"messages": GetMessages("public", user, 0),
+			"messages": GetMessages("public", user, page),
 		})
 	} else {
 		// if there exists a session user, show my timeline
 		c.HTML(http.StatusOK, "timeline.html", gin.H{
-			"messages": GetMessages("myTimeline", user, 0),
+			"messages": GetMessages("myTimeline", user, page),
 			"user":     user,
 			"username": user_name,
 		})
 	}
 }
 
 // ENDPOINT: GET /public
-func Public(c *gin.Context) {
+func Timeline(c *gin.Context) {
+	page := c.DefaultQuery("page", "0")
 
 	if user == -1 {
 		c.HTML(http.StatusOK, "timeline.html", gin.H{
-			"messages": GetMessages("public", user, 0),
+			"messages": GetMessages("public", user, page),
 		})
 	} else {
-		// if there exists a session user, show my timeline
 		c.HTML(http.StatusOK, "timeline.html", gin.H{
-			"messages": GetMessages("public", user, 0),
+			"messages": GetMessages("public", user, page),
 			"user":     user,
 			"username": user_name,
 		})
 	}
+
 }
 
 // ENDPOINT: GET /:username
-func Username(c *gin.Context) { // Displays an individual's timeline
+func UserTimeline(c *gin.Context) { // Displays an individual's timeline
 
 	username := c.Param("username") // gets the <username> from the url
 	userID, err := getUserId(username)
+	page := c.DefaultQuery("page", "0")
+
 	if err != nil {
 		log.Print("Bad request during " + c.Request.RequestURI + ": " + " User " + username + " not found")
 		c.Status(404)
@@ -67,7 +70,7 @@ func Username(c *gin.Context) { // Displays an individual's timeline
 					"user":      user,
 					"private":   true,
 					"user_page": true,
-					"messages":  GetMessages("myTimeline", user, 0),
+					"messages":  GetMessages("myTimeline", user, page),
 					"username":  username,
 				})
 			} else {
@@ -81,7 +84,7 @@ func Username(c *gin.Context) { // Displays an individual's timeline
 						"user":          username,
 						"followed":      followed,
 						"user_page":     users_page,
-						"messages":      GetMessages("individual", int(userID), 0),
+						"messages":      GetMessages("individual", int(userID), page),
 					})
 				} else {
 					// If not following
@@ -92,7 +95,7 @@ func Username(c *gin.Context) { // Displays an individual's timeline
 						"private":       true,
 						"user":          username,
 						"user_page":     users_page,
-						"messages":      GetMessages("individual", int(userID), 0),
+						"messages":      GetMessages("individual", int(userID), page),
 					})
 				}
 			}
@@ -102,7 +105,7 @@ func Username(c *gin.Context) { // Displays an individual's timeline
 				"title":         username + "'s Timeline",
 				"user_timeline": true,
 				"private":       true,
-				"messages":      GetMessages("individual", int(userID), 0),
+				"messages":      GetMessages("individual", int(userID), page),
 			})
 		}
 	}

controllers/tweets_controller.go

@@ -4,6 +4,7 @@ import (
 	"log"
 	"net/http"
 	"time"
+	"strconv"
 
 	"github.com/ContainerMaintainers/MiniTwit-Golang/database"
 	"github.com/ContainerMaintainers/MiniTwit-Golang/infrastructure/entities"
@@ -22,17 +23,30 @@ type JoinedMessage struct {
 	FormattedDate string // new variable to hold the formatted date string
 }
 
-func GetMessages(timelineType string, user int, pagenum int) []JoinedMessage {
+func LimitMessages(page string) (int, int) {
+	messagesPerPage := 50
+	p, err := strconv.Atoi(page)
+	if err != nil {
+		panic("Failed to parse page number")
+	}
+	offset := (p - 1) * messagesPerPage
+	return offset, messagesPerPage
+}
+
+func GetMessages(timelineType string, user int, page string) []JoinedMessage {
+
+	//offset:= 1
+	//messagesPerPage := 1
 
+	offset, messagesPerPage := LimitMessages(page)
 	var joinedMessages []JoinedMessage
 
 	if timelineType == "public" {
 		// Join messages and users tables for public timeline
 		database.DB.Table("messages").
 			Select("messages.Author_id", "users.Username", "messages.Text", "messages.Pub_Date").
 			Joins("left join users on users.id = messages.Author_id").
-			Offset(pagenum * Per_page).
-			Limit(Per_page).
+			Offset(offset).Limit(messagesPerPage).
 			Order("messages.Pub_Date desc").
 			Scan(&joinedMessages)
 
@@ -43,8 +57,7 @@ func GetMessages(timelineType string, user int, pagenum int) []JoinedMessage {
 			Joins("left join followers on messages.author_id = followers.whom_id").
 			Joins("left join users on users.id = messages.Author_id").
 			Where("messages.flagged = ? AND (messages.author_id = ? OR followers.who_id = ?)", false, user, user).
-			Offset(pagenum * Per_page).
-			Limit(Per_page).
+			Offset(offset).Limit(messagesPerPage).
 			Order("messages.Pub_Date desc").
 			Scan(&joinedMessages)
 
@@ -54,8 +67,7 @@ func GetMessages(timelineType string, user int, pagenum int) []JoinedMessage {
 			Select("messages.Author_id", "users.Username", "messages.Text", "messages.Pub_Date").
 			Joins("left join users on users.id = messages.Author_id").
 			Where("messages.flagged = ? AND (messages.author_id = ?)", false, user).
-			Offset(pagenum * Per_page).
-			Limit(Per_page).
+			Offset(offset).Limit(messagesPerPage).
 			Order("messages.Pub_Date desc").
 			Scan(&joinedMessages)
 	}
@@ -105,7 +117,7 @@ func AddMessage(c *gin.Context) { // Registers a new message for the user.
 		"user":      user,
 		"private":   true,
 		"user_page": true,
-		"messages":  GetMessages("myTimeline", user, 0),
+		"messages":  GetMessages("myTimeline", user, "0"),
 		"username":  username,
 	})
 }

deploy.sh

@@ -21,6 +21,7 @@ echo "Pulling latest version"
 docker pull $1/minitwit:latest
 echo "Stopping current minitwit"
 docker stop minitwit || true
+docker rm minitwit || true
 echo "Deploying $DOCKER_USERNAME/minitwit:latest to $PORT"
 docker run -d \
 	-p $2:$2 \

docker-compose.yml

@@ -72,6 +72,10 @@ services:
 
   grafana:
     image: grafana/grafana:9.4.7
+    container_name: grafana
+    volumes:
+      - ./grafana/dashboards:/var/lib/grafana/dashboards
+      - ./grafana/provisioning:/etc/grafana/provisioning
     ports:
       - "3000:3000"  
     networks: