- add documentation in container

ryaben17 · ryaben17 · commit 86c155747c54 · 2021-03-31T11:46:45.000+02:00
diff --git a/Makefile b/Makefile
@@ -0,0 +1,12 @@
+# Makefile
+APPNAME=riotpot
+CURRENT_DIR=`pwd`
+PACKAGE_DIRS=`go list -e ./... | egrep -v "binary_output_dir|.git|mocks"`
+DOCKERFILE=docker/Dockerfile.documentation
+
+# docker cmd below
+.PHONY:  docker-build docker-run
+docker-build:
+	docker build -f $(DOCKERFILE) . -t $(APPNAME)/v1
+docker-run: docker-build
+	docker run -p 6060:6060 -it $(APPNAME)/v1
diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -1,9 +1,7 @@
-"""
-This Docker Compose file is meant to be used on a development 
-environment for testing.
-This environment includes a fake local network, a local database and
-a volume mounted with the code to see changes on the go.
-"""
+# This Docker Compose file is meant to be used on a development 
+# environment for testing.
+# This environment includes a fake local network, a local database and
+# a volume mounted with the code to see changes on the go.
 
 version: "3.8"
 services:
diff --git a/docker/Dockerfile.documentation b/docker/Dockerfile.documentation
@@ -0,0 +1,18 @@
+# Start from the latest golang base image
+FROM golang:latest
+
+# env setup for reusability
+ENV APP_NAME=riotpot
+ENV WORKING_DIR=$GOPATH/src/github.com/aau/$APP_NAME
+
+# get godoc
+RUN go get golang.org/x/tools/cmd/godoc
+
+# Set the working directory to golang working space
+WORKDIR $WORKING_DIR
+
+# Copy the current directory contents into the container at current directory
+ADD riotpot/ .
+
+CMD godoc -http=:6060
+
diff --git a/riotpot/main.go b/riotpot/main.go
@@ -13,26 +13,35 @@ import (
 
 var wg sync.WaitGroup
 
+// main starts all the submodules containing the emulators.
+// It is the first function called when the application is run.
+// It also acts as an orchestrator, which dictates the functioning of the application.
 func main() {
-
 	if environ.Getenv("SERVICES", "") == "" {
-		wg.Add(1)
+		wg.Add(1) // add a goroutine to the stack, blocking until all services are up.
+
+		//----------------
+		// Add here all the services that must be run by default if either there is no
+		// environment file or variables which define this behaviour otherwise.
+		//----------------
 		go telnet_serv()
 		go http_serv()
-		go ssh_serv() //Starts SSH Server
+		go ssh_serv()
 		//go trydy_proxy_serv()
-		wg.Wait()
-	} else {
+		//----------------
 
+		wg.Wait() // wait until the goroutines call Done or are over.
+	} else {
+		// TODO: add the logic to the loop.
 	}
 }
 
+/*
+Print to the console if the server successfully started
+@service: the name of the service
+@out: the integer result of the server started, 1 or 0 , where 0 is a falsy value.
+*/
 func serv_out(service string, out int) {
-	/*
-		Print to the console if the server successfully started
-		@service: the name of the service
-		@out: the integer result of the server started, 1 or 0 , where 0 is a falsy value.
-	*/
 
 	if out > 0 {
 		fmt.Printf("%s Server Started", service)
@@ -41,18 +50,18 @@ func serv_out(service string, out int) {
 	}
 }
 
+/*Start SSH server*/
 func ssh_serv() {
-	/*Start SSH server*/
 	sshd.SSHServer()
 }
 
+/* Start Telnet server */
 func telnet_serv() {
-	/* Start Telnet server */
 	telnetd.TelnetServer()
 }
 
+/* Start HTTP server */
 func http_serv() {
-	/* Start HTTP server */
 	httpd.HttpServer()
 }
 
