Make the go sample application work with docker compose (#176)

* Make the go application work with docker compose.
* Updated README.md.
* Formatted main.go using gofmt.
* Add newlines to few files as recommended by Github.

Author: sjs994

go/samples/http/.gitignore

@@ -1,2 +1 @@
-sqlcommenter-http
-docker-data/
+docker-data/

go/samples/http/Dockerfile

@@ -0,0 +1,28 @@
+# Build Stage
+# First pull Golang image
+FROM golang:1.19-alpine as build-env
+
+ENV APP_NAME sqlcommenter-http
+ENV CMD_PATH main.go
+ 
+# Copy application data into image
+COPY . $GOPATH/src/$APP_NAME
+WORKDIR $GOPATH/src/$APP_NAME
+ 
+# Budild application
+RUN CGO_ENABLED=0 go build -v -o /$APP_NAME $GOPATH/src/$APP_NAME/$CMD_PATH
+ 
+# Run Stage
+FROM alpine:3.16.3
+ 
+# Set environment variable
+ENV APP_NAME sqlcommenter-http
+ 
+# Copy only required data into this image
+COPY --from=build-env /$APP_NAME .
+ 
+# Expose application port
+EXPOSE 8081
+ 
+# Start app
+CMD ["./sqlcommenter-http", "--db_engine=mysql"]

go/samples/http/README.md

@@ -1,18 +1,33 @@
 # sqlcommenter-http
 
+This is a sample application used to test out `sqlcommenter-go-http` instrumentation libraries.
 
 ## Installation
 
+We have containerized this application and its related dependencies (i.e. Postgres and MySQL servers) using `docker-compose`.
 
-* Clone the source
-* Update `connection` string in Index function
-* Install dependencies
-	```
-	go build
-	```
+To start the application:
+```sh
+docker compose build
+docker compose up
+```
 
-* Run the app
-   ```
-	go run main.go
-	````
-* Hit the url http://localhost:8080/ and observe the mysql logs to see comments appended
+This will start the application server as well as MySQL and Postgres databases 
+(NOTE: At present both database will start even if one is used). 
+
+By default the application server will connect with `Postgres` database. To change that,
+update the `db_engine` parameter in the [`Dockerfile`](https://github.com/google/sqlcommenter/blob/master/go/samples/http/Dockerfile) to `mysql`.
+
+To view postgres logs, just use the `docker logs` command:
+
+```sh
+docker logs --follow postgres
+```
+
+To view MySQL logs, use the provided script `./tail_mysql_log.sh`.
+
+
+## Execution
+Hit the url http://localhost:8081/ and observe the MySQL/Postgres logs to see comments appended.
+
+Alternatively, there are few scripts present in the `curls` folder to execute CRUD operations.

go/samples/http/curls/delete.sh

@@ -2,5 +2,5 @@
 
 curl --header "Content-Type: application/json" \
   --request DELETE \
-  http://localhost:8080/todos/$1
+  http://localhost:8081/todos/$1
 echo

go/samples/http/curls/index.sh

@@ -1,4 +1,4 @@
 # usage: index.sh
 
-curl http://localhost:8080
+curl http://localhost:8081
 echo

go/samples/http/curls/insert.sh

@@ -3,5 +3,5 @@
 curl --header "Content-Type: application/json" \
   --request POST \
   --data '{"task":"'$1'"}' \
-  http://localhost:8080/todos
+  http://localhost:8081/todos
 echo

go/samples/http/curls/list.sh

@@ -1,4 +1,4 @@
 # usage: list.sh
 
-curl http://localhost:8080/todos?search=$1
+curl http://localhost:8081/todos?search=$1
 echo

go/samples/http/curls/update.sh

@@ -3,5 +3,5 @@
 curl --header "Content-Type: application/json" \
   --request PUT \
   --data '{"task":"'$2'"}' \
-  http://localhost:8080/todos/$1
+  http://localhost:8081/todos/$1
 echo

go/samples/http/docker-compose.yml

@@ -1,27 +1,62 @@
 version: '3.8'
+networks:
+  mynet:
+    driver: bridge
+
+
 services:
-  sqlcommenter_mysql_db:
-    container_name: sqlcommenter_mysql_db
+  mysql:
+    container_name: mysql
     image: mysql:8
     command:
       --general-log=TRUE
       --general-log-file=/var/lib/mysql/mysql-log.log
     ports:
-      - '3306:3306'
+      - 3306:3306
     environment:
       MYSQL_DATABASE: 'sqlcommenter_db'
       MYSQL_ROOT_PASSWORD: 'password'
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    networks:
+      - mynet 
     volumes:
-      - './docker-data/mysql:/var/lib/postgresql/data'
-  sqlcommenter_pg_db:
-    container_name: sqlcommenter_pg_db
+      - './docker-data/mysql:/var/lib/mysql'
+  postgres:
     image: postgres:14
+    container_name: postgres
+    # restart: always
+    volumes:
+      - './docker-data/postgres:/var/lib/postgresql/data'
     command: postgres -c log_statement=all
     ports:
-      - '5432:5432'
+      - 5432:5432
     environment:
-      POSTGRES_USER: dev
-      POSTGRES_PASSWORD: dev
-      POSTGRES_DB: sqlcommenter_db
-    volumes:
-      - './docker-data/pg:/var/lib/postgresql/data'
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    networks:
+      - mynet
+  http-service:
+    container_name: http-service
+    build:
+      context: .
+    depends_on:
+      postgres:
+        condition: service_healthy
+      mysql:
+        condition: service_healthy
+    links:
+      - postgres
+      - mysql
+    ports:
+      - 8081:8081
+    networks:
+      - mynet

go/samples/http/main.go

@@ -76,19 +76,21 @@ func runApp(todosController *todos.TodosController) {
 	router.PUT("/todos/:id", middleware(todosController.ActionUpdate))
 	router.DELETE("/todos/:id", middleware(todosController.ActionDelete))
 
-	http.ListenAndServe(":8080", router)
+	http.ListenAndServe(":8081", router)
 }
 
+// host = “host.docker.internal”
+
 func runForMysql() *gosql.DB {
-	connection := "root:password@/sqlcommenter_db"
+	connection := "root:password@tcp(mysql:3306)/sqlcommenter_db"
 	db := mysqldb.ConnectMySQL(connection)
 	todosController := &todos.TodosController{Engine: "mysql", DB: db, SQL: todos.MySQLQueries{}}
 	runApp(todosController)
 	return db
 }
 
 func runForPg() *gosql.DB {
-	connection := "postgres://dev:dev@localhost/sqlcommenter_db?sslmode=disable"
+	connection := "host=postgres user=postgres password=postgres dbname=postgres port=5432 sslmode=disable"
 	db := pgdb.ConnectPG(connection)
 	todosController := &todos.TodosController{Engine: "pg", DB: db, SQL: todos.PGQueries{}}
 	runApp(todosController)