[Feature]: Support for execution logs files (#92)

* added support for execution log file

* updated makefile

* fixed linting

* updated linting

* updated linting

* made function internal

Author: nevilm-lt

.gitignore

@@ -80,3 +80,4 @@ mould.log
 .env
 
 .synapse.json
+logs

Makefile

@@ -7,14 +7,17 @@ SYNAPSE_IMAGE_NAME ?= lambdatest/synapse:latest
 usage:						## Show this help
 	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/:.*##\s*/##/g' | awk -F'##' '{ printf "%-25s -> %s\n", $$1, $$2 }'
 
-build-nucleus-image:		## builds nucleus docker image
+lint:						## Runs linting
+	golangci-lint run
+
+build-nucleus-image:		## Builds nucleus docker image
 	docker build -t ${NUCLEUS_IMAGE_NAME} --file $(NUCLEUS_DOCKER_FILE) .
 
-build-nucleus-bin:			## builds nucleus binary
+build-nucleus-bin:			## Builds nucleus binary
 	bash build/nucleus/build.sh
 
-build-synapse-image:		## builds synapse docker image
+build-synapse-image:		## Builds synapse docker image
 	docker build -t ${SYNAPSE_IMAGE_NAME} --file $(SYNAPSE_DOCKER_FILE) .
 
-build-synapse-bin:			## builds synapse binary
+build-synapse-bin:			## Builds synapse binary
 	bash build/synapse/build.sh

docker-compose.yml

@@ -14,6 +14,7 @@ services:
       - "/tmp/synapse:/tmp/synapse"
       - ".synapse.json:/home/synapse/.synapse.json"
       - "/etc/machine-id:/etc/machine-id"
+      - "./logs/synapse:/var/log/synapse"
 
 networks:
   test-at-scale:

pkg/global/synapseconstants.go

@@ -21,6 +21,7 @@ const (
 	AutoRemove            = true
 	Local                 = true
 	MaxConnectionAttempts = 10
+	ExecutionLogsPath     = "/var/log/synapse"
 )
 
 // SocketURL lambdatest url for synapse socket

pkg/runner/docker/docker.go

@@ -14,9 +14,12 @@ import (
 	"github.com/LambdaTest/synapse/pkg/errs"
 	"github.com/LambdaTest/synapse/pkg/global"
 	"github.com/LambdaTest/synapse/pkg/lumber"
+	"github.com/LambdaTest/synapse/pkg/synapse"
+	"github.com/LambdaTest/synapse/pkg/utils"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/client"
+	"github.com/docker/docker/pkg/stdcopy"
 )
 
 const (
@@ -149,6 +152,10 @@ func (d *docker) Run(ctx context.Context, r *core.RunnerOptions) core.ContainerS
 	}
 	d.RunningContainers = append(d.RunningContainers, r)
 
+	if err := d.writeLogs(ctx, r); err != nil {
+		d.logger.Errorf("error writing logs to stdout: %+v", err)
+	}
+
 	return containerStatus
 }
 
@@ -271,3 +278,36 @@ func (d *docker) PullImage(containerImageConfig *core.ContainerImageConfig, r *c
 	}
 	return nil
 }
+
+// writeLogs writes container logs to a file
+func (d *docker) writeLogs(ctx context.Context, r *core.RunnerOptions) error {
+	reader, err := d.client.ContainerLogs(ctx,
+		r.ContainerID,
+		types.ContainerLogsOptions{
+			ShowStdout: true,
+			ShowStderr: true,
+			Follow:     true,
+		})
+	if err != nil {
+		return err
+	}
+	defer reader.Close()
+
+	buildLogsPath := fmt.Sprintf("%s/%s", global.ExecutionLogsPath, r.Label[synapse.BuildID])
+
+	if errDir := utils.CreateDirectory(buildLogsPath); err != nil {
+		return errDir
+	}
+
+	f, err := os.Create(fmt.Sprintf("%s/%s-%s.log", buildLogsPath, r.ContainerName, r.PodType))
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	if _, errCopy := stdcopy.StdCopy(f, f, reader); err != nil {
+		return errCopy
+	}
+
+	return nil
+}