resolving merge conflicts

coder · Kira-Pilot · May 31, 2022 · May 27, 2022 · May 27, 2022 · May 31, 2022
commit aca771174115eb37a324b5074f7b28485f3d80d7
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -29,6 +29,6 @@ ignore:
   - peerbroker/proto
   - provisionerd/proto
   - provisionersdk/proto
-  - scripts/datadog-cireport
+  - scripts
   - site/.storybook
   - rules.go
diff --git a/README.md b/README.md
@@ -8,10 +8,10 @@ Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache
 Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
 [![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
 
-Coder creates remote development machines so you can develop your code from anywhere.
+Coder creates remote development machines so you can develop your code from anywhere. #coder
 
 > **Note**:
-> Coder is in an alpha state, but any serious bugs are P1 for us so please report them.
+> Coder is in an alpha state, but any serious bugs are P1 for us so [please report them](https://github.com/coder/coder/issues/new/choose).
 
 <p align="center">
   <img src="./docs/images/hero-image.png">
@@ -153,6 +153,12 @@ coder templates update gcp-linux
   - [Workspace lifecycle](./docs/workspaces.md#workspace-lifecycle)
   - [Updating workspaces](./docs/workspaces.md#updating-workspaces)
 
+## Community
+
+Join the community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq) #coder!
+
+[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
+
 ## Comparison
 
 Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](./docs/about.md#what-coder-is-not).

diff --git a/cli/logout.go b/cli/logout.go
@@ -3,6 +3,7 @@ package cli
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/spf13/cobra"
 	"golang.org/x/xerrors"
@@ -15,11 +16,16 @@ func logout() *cobra.Command {
 		Use:   "logout",
 		Short: "Remove the local authenticated session",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			var isLoggedOut bool
+			client, err := createClient(cmd)
+			if err != nil {
+				return err
+			}
+
+			var errors []error
 
 			config := createConfig(cmd)
 
-			_, err := cliui.Prompt(cmd, cliui.PromptOptions{
+			_, err = cliui.Prompt(cmd, cliui.PromptOptions{
 				Text:      "Are you sure you want to logout?",
 				IsConfirm: true,
 				Default:   "yes",
@@ -28,38 +34,40 @@ func logout() *cobra.Command {
 				return err
 			}
 
-			err = config.URL().Delete()
+			err = client.Logout(cmd.Context())
 			if err != nil {
-				// Only throw error if the URL configuration file is present,
-				// otherwise the user is already logged out, and we proceed
-				if !os.IsNotExist(err) {
-					return xerrors.Errorf("remove URL file: %w", err)
-				}
-				isLoggedOut = true
+				errors = append(errors, xerrors.Errorf("logout api: %w", err))
+			}
+
+			err = config.URL().Delete()
+			// Only throw error if the URL configuration file is present,
+			// otherwise the user is already logged out, and we proceed
+			if err != nil && !os.IsNotExist(err) {
+				errors = append(errors, xerrors.Errorf("remove URL file: %w", err))
 			}
 
 			err = config.Session().Delete()
-			if err != nil {
-				// Only throw error if the session configuration file is present,
-				// otherwise the user is already logged out, and we proceed
-				if !os.IsNotExist(err) {
-					return xerrors.Errorf("remove session file: %w", err)
-				}
-				isLoggedOut = true
+			// Only throw error if the session configuration file is present,
+			// otherwise the user is already logged out, and we proceed
+			if err != nil && !os.IsNotExist(err) {
+				errors = append(errors, xerrors.Errorf("remove session file: %w", err))
 			}
 
 			err = config.Organization().Delete()
 			// If the organization configuration file is absent, we still proceed
 			if err != nil && !os.IsNotExist(err) {
-				return xerrors.Errorf("remove organization file: %w", err)
+				errors = append(errors, xerrors.Errorf("remove organization file: %w", err))
 			}
 
-			// If the user was already logged out, we show them a different message
-			if isLoggedOut {
-				_, _ = fmt.Fprintf(cmd.OutOrStdout(), notLoggedInMessage+"\n")
-			} else {
-				_, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"Successfully logged out.\n")
+			if len(errors) > 0 {
+				var errorStringBuilder strings.Builder
+				for _, err := range errors {
+					_, _ = fmt.Fprint(&errorStringBuilder, "\t"+err.Error()+"\n")
+				}
+				errorString := strings.TrimRight(errorStringBuilder.String(), "\n")
+				return xerrors.New("Failed to log out.\n" + errorString)
 			}
+			_, _ = fmt.Fprintf(cmd.OutOrStdout(), caret+"You are no longer logged in. You can log in using 'coder login <url>'.\n")
 			return nil
 		},
 	}

diff --git a/cli/logout_test.go b/cli/logout_test.go
@@ -1,7 +1,10 @@
 package cli_test
 
 import (
+	"fmt"
 	"os"
+	"regexp"
+	"runtime"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -21,7 +24,7 @@ func TestLogout(t *testing.T) {
 		pty := ptytest.New(t)
 		config := login(t, pty)
 
-		// ensure session files exist
+		// Ensure session files exist.
 		require.FileExists(t, string(config.URL()))
 		require.FileExists(t, string(config.Session()))
 
@@ -40,7 +43,7 @@ func TestLogout(t *testing.T) {
 
 		pty.ExpectMatch("Are you sure you want to logout?")
 		pty.WriteLine("yes")
-		pty.ExpectMatch("Successfully logged out")
+		pty.ExpectMatch("You are no longer logged in. You can log in using 'coder login <url>'.")
 		<-logoutChan
 	})
 	t.Run("SkipPrompt", func(t *testing.T) {
@@ -49,7 +52,7 @@ func TestLogout(t *testing.T) {
 		pty := ptytest.New(t)
 		config := login(t, pty)
 
-		// ensure session files exist
+		// Ensure session files exist.
 		require.FileExists(t, string(config.URL()))
 		require.FileExists(t, string(config.Session()))
 
@@ -66,7 +69,7 @@ func TestLogout(t *testing.T) {
 			assert.NoFileExists(t, string(config.Session()))
 		}()
 
-		pty.ExpectMatch("Successfully logged out")
+		pty.ExpectMatch("You are no longer logged in. You can log in using 'coder login <url>'.")
 		<-logoutChan
 	})
 	t.Run("NoURLFile", func(t *testing.T) {
@@ -75,7 +78,7 @@ func TestLogout(t *testing.T) {
 		pty := ptytest.New(t)
 		config := login(t, pty)
 
-		// ensure session files exist
+		// Ensure session files exist.
 		require.FileExists(t, string(config.URL()))
 		require.FileExists(t, string(config.Session()))
 
@@ -91,14 +94,9 @@ func TestLogout(t *testing.T) {
 		go func() {
 			defer close(logoutChan)
 			err := logout.Execute()
-			assert.NoError(t, err)
-			assert.NoFileExists(t, string(config.URL()))
-			assert.NoFileExists(t, string(config.Session()))
+			assert.EqualError(t, err, "You are not logged in. Try logging in using 'coder login <url>'.")
 		}()
 
-		pty.ExpectMatch("Are you sure you want to logout?")
-		pty.WriteLine("yes")
-		pty.ExpectMatch("You are not logged in. Try logging in using 'coder login <url>'.")
 		<-logoutChan
 	})
 	t.Run("NoSessionFile", func(t *testing.T) {
@@ -107,7 +105,7 @@ func TestLogout(t *testing.T) {
 		pty := ptytest.New(t)
 		config := login(t, pty)
 
-		// ensure session files exist
+		// Ensure session files exist.
 		require.FileExists(t, string(config.URL()))
 		require.FileExists(t, string(config.Session()))
 
@@ -123,14 +121,73 @@ func TestLogout(t *testing.T) {
 		go func() {
 			defer close(logoutChan)
 			err = logout.Execute()
-			assert.NoError(t, err)
-			assert.NoFileExists(t, string(config.URL()))
-			assert.NoFileExists(t, string(config.Session()))
+			assert.EqualError(t, err, "You are not logged in. Try logging in using 'coder login <url>'.")
+		}()
+
+		<-logoutChan
+	})
+	t.Run("CannotDeleteFiles", func(t *testing.T) {
+		t.Parallel()
+
+		pty := ptytest.New(t)
+		config := login(t, pty)
+
+		// Ensure session files exist.
+		require.FileExists(t, string(config.URL()))
+		require.FileExists(t, string(config.Session()))
+
+		var (
+			err         error
+			urlFile     *os.File
+			sessionFile *os.File
+		)
+		if runtime.GOOS == "windows" {
+			// Opening the files so Windows does not allow deleting them.
+			urlFile, err = os.Open(string(config.URL()))
+			require.NoError(t, err)
+			sessionFile, err = os.Open(string(config.Session()))
+			require.NoError(t, err)
+		} else {
+			// Changing the permissions to throw error during deletion.
+			err = os.Chmod(string(config), 0500)
+			require.NoError(t, err)
+		}
+		t.Cleanup(func() {
+			if runtime.GOOS == "windows" {
+				// Closing the opened files for cleanup.
+				err = urlFile.Close()
+				require.NoError(t, err)
+				err = sessionFile.Close()
+				require.NoError(t, err)
+			} else {
+				// Setting the permissions back for cleanup.
+				err = os.Chmod(string(config), 0700)
+				require.NoError(t, err)
+			}
+		})
+
+		logoutChan := make(chan struct{})
+		logout, _ := clitest.New(t, "logout", "--global-config", string(config))
+
+		logout.SetIn(pty.Input())
+		logout.SetOut(pty.Output())
+
+		go func() {
+			defer close(logoutChan)
+			err := logout.Execute()
+			assert.NotNil(t, err)
+			var errorMessage string
+			if runtime.GOOS == "windows" {
+				errorMessage = "The process cannot access the file because it is being used by another process."
+			} else {
+				errorMessage = "permission denied"
+			}
+			errRegex := regexp.MustCompile(fmt.Sprintf("Failed to log out.\n\tremove URL file: .+: %s\n\tremove session file: .+: %s", errorMessage, errorMessage))
+			assert.Regexp(t, errRegex, err.Error())
 		}()
 
 		pty.ExpectMatch("Are you sure you want to logout?")
 		pty.WriteLine("yes")
-		pty.ExpectMatch("You are not logged in. Try logging in using 'coder login <url>'.")
 		<-logoutChan
 	})
 }

diff --git a/coderd/autobuild/executor/lifecycle_executor.go b/coderd/autobuild/executor/lifecycle_executor.go
@@ -17,10 +17,18 @@ import (
 
 // Executor automatically starts or stops workspaces.
 type Executor struct {
-	ctx  context.Context
-	db   database.Store
-	log  slog.Logger
-	tick <-chan time.Time
+	ctx     context.Context
+	db      database.Store
+	log     slog.Logger
+	tick    <-chan time.Time
+	statsCh chan<- Stats
+}
+
+// Stats contains information about one run of Executor.
+type Stats struct {
+	Transitions map[uuid.UUID]database.WorkspaceTransition
+	Elapsed     time.Duration
+	Error       error
 }
 
 // New returns a new autobuild executor.
@@ -34,22 +42,42 @@ func New(ctx context.Context, db database.Store, log slog.Logger, tick <-chan ti
 	return le
 }
 
+// WithStatsChannel will cause Executor to push a RunStats to ch after
+// every tick.
+func (e *Executor) WithStatsChannel(ch chan<- Stats) *Executor {
+	e.statsCh = ch
+	return e
+}
+
 // Run will cause executor to start or stop workspaces on every
 // tick from its channel. It will stop when its context is Done, or when
 // its channel is closed.
 func (e *Executor) Run() {
 	go func() {
 		for t := range e.tick {
-			if err := e.runOnce(t); err != nil {
-				e.log.Error(e.ctx, "error running once", slog.Error(err))
+			stats := e.runOnce(t)
+			if stats.Error != nil {
+				e.log.Error(e.ctx, "error running once", slog.Error(stats.Error))
 			}
+			if e.statsCh != nil {
+				e.statsCh <- stats
+			}
+			e.log.Debug(e.ctx, "run stats", slog.F("elapsed", stats.Elapsed), slog.F("transitions", stats.Transitions))
 		}
 	}()
 }
 
-func (e *Executor) runOnce(t time.Time) error {
+func (e *Executor) runOnce(t time.Time) Stats {
+	var err error
+	stats := Stats{
+		Transitions: make(map[uuid.UUID]database.WorkspaceTransition),
+	}
+	defer func() {
+		stats.Elapsed = time.Since(t)
+		stats.Error = err
+	}()
 	currentTick := t.Truncate(time.Minute)
-	return e.db.InTx(func(db database.Store) error {
+	err = e.db.InTx(func(db database.Store) error {
 		// TTL is set at the workspace level, and deadline at the workspace build level.
 		// When a workspace build is created, its deadline initially starts at zero.
 		// When provisionerd successfully completes a provision job, the deadline is
@@ -146,6 +174,7 @@ func (e *Executor) runOnce(t time.Time) error {
 				slog.F("transition", validTransition),
 			)
 
+			stats.Transitions[ws.ID] = validTransition
 			if err := build(e.ctx, db, ws, validTransition, priorHistory, priorJob); err != nil {
 				e.log.Error(e.ctx, "unable to transition workspace",
 					slog.F("workspace_id", ws.ID),
@@ -156,6 +185,7 @@ func (e *Executor) runOnce(t time.Time) error {
 		}
 		return nil
 	})
+	return stats
 }
 
 // TODO(cian): this function duplicates most of api.postWorkspaceBuilds. Refactor.