chore(engine): polish Go comments per project style

Author: NikolayS

engine/cmd/cli/commands/branch/actions.go

@@ -32,7 +32,7 @@ DataStateAt: {{.DataStateAt | formatDSA }}{{if and (ne .Message "-") (ne .Messag
 {{end}}`
 )
 
-// Create a new template and parse the letter into it.
+// create a new template and parse the letter into it.
 var logTemplate = template.Must(template.New("branchLog").Funcs(
 	template.FuncMap{
 		"formatDSA": func(dsa string) string {
@@ -86,17 +86,17 @@ func list(cliCtx *cli.Context) error {
 		return err
 	}
 
-	// Create a new branch.
+	// create a new branch.
 	if branchName := cliCtx.Args().First(); branchName != "" {
 		return create(cliCtx)
 	}
 
-	// Delete branch.
+	// delete branch.
 	if branchName := cliCtx.String("delete"); branchName != "" {
 		return deleteBranch(cliCtx)
 	}
 
-	// List branches.
+	// list branches.
 	branches, err := dblabClient.ListBranches(cliCtx.Context)
 	if err != nil {
 		return err

engine/cmd/cli/commands/port_forwarding.go

@@ -37,7 +37,7 @@ func BuildTunnel(cliCtx *cli.Context, remoteHost *url.URL) (*portfwd.SSHTunnel,
 			authMethod,
 		},
 		HostKeyCallback: func(hostname string, remote net.Addr, key ssh.PublicKey) error {
-			// Always accept key.
+			// always accept key.
 			return nil
 		},
 	}

engine/cmd/cli/main.go

@@ -30,10 +30,10 @@ func main() {
 		},
 		Before: loadEnvironmentParams,
 		Commands: joinCommands(
-			// Config commands.
+			// config commands.
 			global.List(),
 
-			// Branching.
+			// branching.
 			branch.List(),
 
 			// Database Lab API.
@@ -116,7 +116,7 @@ func loadEnvironmentParams(c *cli.Context) error {
 
 	cfg, err := config.Load(filename)
 	if err != nil {
-		// Failed to load config, skip auto-loading environment keys.
+		// failed to load config, skip auto-loading environment keys.
 		return nil
 	}
 
@@ -185,7 +185,7 @@ func loadEnvironmentParams(c *cli.Context) error {
 }
 
 func joinCommands(cliGroups ...[]*cli.Command) []*cli.Command {
-	// There are at least len(cliGroups) elements.
+	// there are at least len(cliGroups) elements.
 	cliCommands := make([]*cli.Command, 0, len(cliGroups))
 
 	for _, cliGroup := range cliGroups {

engine/internal/provision/databases/postgres/postgres_mgmt.go

@@ -91,7 +91,7 @@ func CreateUser(c *resources.AppConfig, user resources.EphemeralUser) error {
 	}
 
 	if user.Restricted {
-		// Create or alter restricted user.
+		// create or alter restricted user.
 		query = restrictedUserQuery(user.Name, user.Password, userExists)
 		out, err := runSimpleSQL(query, pgConnStr)
 
@@ -101,7 +101,7 @@ func CreateUser(c *resources.AppConfig, user resources.EphemeralUser) error {
 
 		log.Dbg("Restricted user has been created: ", out)
 
-		// Change user ownership.
+		// change user ownership.
 		query = restrictedUserOwnershipQuery(user.Name, user.Password)
 		out, err = runSimpleSQL(query, pgConnStr)
 
@@ -111,7 +111,7 @@ func CreateUser(c *resources.AppConfig, user resources.EphemeralUser) error {
 
 		log.Dbg("Database ownership has been changed: ", out)
 
-		// Set restricted user as owner for database objects.
+		// set restricted user as owner for database objects.
 		databaseList, err := runSQLSelectQuery(selectAllDatabases, pgConnStr)
 
 		if err != nil {

engine/internal/provision/docker/docker.go

@@ -56,8 +56,8 @@ func RunContainer(r runners.Runner, c *resources.AppConfig) error {
 	log.Dbg(fmt.Sprintf("Host info: %#v", hostInfo))
 
 	if hostInfo.VirtualizationRole == "guest" {
-		// Build custom mounts rely on mounts of the Database Lab instance if it's running inside Docker container.
-		// We cannot use --volumes-from because it removes the ZFS mount point.
+		// build custom mounts rely on mounts of the Database Lab instance if it's running inside Docker container.
+		// we cannot use --volumes-from because it removes the ZFS mount point.
 		volumes, err = getMountVolumes(r, c, hostInfo.Hostname)
 		if err != nil {
 			return errors.Wrap(err, "failed to detect container volumes")
@@ -119,7 +119,7 @@ func publishPorts(provisionHosts string, instancePort string) string {
 func createDefaultVolumes(c *resources.AppConfig) (string, []string) {
 	unixSocketCloneDir := c.Pool.SocketCloneDir(c.CloneName)
 
-	// Directly mount PGDATA if Database Lab is running without any virtualization.
+	// directly mount PGDATA if Database Lab is running without any virtualization.
 	volumes := []string{
 		fmt.Sprintf("--volume %s:%s", c.CloneDir(), c.CloneDir()),
 		fmt.Sprintf("--volume %s:%s", unixSocketCloneDir, unixSocketCloneDir),
@@ -151,15 +151,15 @@ func buildVolumesFromMountPoints(c *resources.AppConfig, mountPoints []container
 	volumes := make([]string, 0, len(mounts))
 
 	for _, mountPoint := range mountPoints {
-		// Add an extra mount for socket directories.
+		// add an extra mount for socket directories.
 		if strings.HasPrefix(unixSocketCloneDir, mountPoint.Destination) {
 			volumes = append(volumes, buildSocketMount(unixSocketCloneDir, mountPoint.Source, mountPoint.Destination))
 			break
 		}
 	}
 
 	for _, mount := range mounts {
-		// Exclude system and non-data volumes from a clone container.
+		// exclude system and non-data volumes from a clone container.
 		if isSystemVolume(mount.Source) || !strings.HasPrefix(mount.Source, c.Pool.MountDir) {
 			continue
 		}

engine/internal/provision/runners/runners.go

@@ -52,8 +52,8 @@ func NewRunnerError(command string, stderr string, e error) error {
 
 	case (*exec.ExitError):
 		// SO: https://stackoverflow.com/questions/10385551/get-exit-code-go.
-		// The program has exited with an exit code != 0
-		// This works on both Unix and Windows. Although package
+		// the program has exited with an exit code != 0.
+		// this works on both Unix and Windows. Although package
 		// syscall is generally platform dependent, WaitStatus is
 		// defined for both Unix and Windows and in both cases has
 		// an ExitStatus() method with the same signature.
@@ -124,19 +124,19 @@ func (r *LocalRunner) Run(command string, options ...bool) (string, error) {
 	cmd.Stdout = &out
 	cmd.Stderr = &stderr
 
-	// TODO(anatoly): Remove hot fix of pg_ctl endless wait.
+	// TODO(anatoly): remove hot fix of pg_ctl endless wait.
 	if strings.Contains(command, "start") {
 		cmd.Stdout = os.Stdout
 		cmd.Stderr = os.Stderr
 	}
 
-	// Psql with the file option returns error response to stderr with
+	// psql with the file option returns error response to stderr with
 	// success exit code. In that case err will be nil, but we need
 	// to treat the case as error and read proper output.
 	err := cmd.Run()
 	psqlErr := strings.Contains(command, "psql") && len(stderr.String()) > 0
 
-	// TODO(anatoly): Remove hotfix.
+	// TODO(anatoly): remove hotfix.
 	psqlErr = psqlErr && !strings.Contains(stderr.String(), "unable to resolve host")
 
 	if err != nil || psqlErr {
@@ -158,7 +158,7 @@ func (r *LocalRunner) Run(command string, options ...bool) (string, error) {
 	return outFormatted, nil
 }
 
-// Utils.
+// utils.
 func parseOptions(options ...bool) bool {
 	logsEnabled := LogsEnabledDefault
 	if len(options) > 0 {

engine/internal/retrieval/engine/postgres/tools/tools.go

@@ -746,8 +746,8 @@ func processAttachResponse(ctx context.Context, reader io.Reader) ([]byte, error
 	return bytes.TrimSpace(outBuf.Bytes()), nil
 }
 
-// CreateContainerIfMissing create a new container if there is no other container with the same name, if the container
-// exits returns existing container id.
+// CreateContainerIfMissing creates a new container if no container with the same name exists.
+// If a container with the same name already exists, its ID is returned.
 func CreateContainerIfMissing(ctx context.Context, docker *client.Client, containerName string,
 	config *container.Config, hostConfig *container.HostConfig) (string, error) {
 	containerData, err := docker.ContainerInspect(ctx, containerName)