Skip to content

feat: add cohesive e2e tests for the web terminal, apps, and workspaces #8140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ site/storybook-static/
site/test-results/*
site/e2e/test-results/*
site/e2e/states/*.json
site/e2e/.auth.json
site/playwright-report/*
site/.swc
site/dist/
Expand Down
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ site/storybook-static/
site/test-results/*
site/e2e/test-results/*
site/e2e/states/*.json
site/e2e/.auth.json
site/playwright-report/*
site/.swc
site/dist/
Expand Down Expand Up @@ -74,3 +75,6 @@ helm/templates/*.yaml

# Testdata shouldn't be formatted.
scripts/apitypings/testdata/**/*.ts

# Generated files shouldn't be formatted.
site/e2e/provisionerGenerated.ts
3 changes: 3 additions & 0 deletions .prettierignore.include
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ helm/templates/*.yaml

# Testdata shouldn't be formatted.
scripts/apitypings/testdata/**/*.ts

# Generated files shouldn't be formatted.
site/e2e/provisionerGenerated.ts
85 changes: 42 additions & 43 deletions cli/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -821,7 +821,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
for i := int64(0); i < cfg.Provisioner.Daemons.Value(); i++ {
daemonCacheDir := filepath.Join(cacheDir, fmt.Sprintf("provisioner-%d", i))
daemon, err := newProvisionerDaemon(
ctx, coderAPI, provisionerdMetrics, logger, cfg, daemonCacheDir, errCh, false, &provisionerdWaitGroup,
ctx, coderAPI, provisionerdMetrics, logger, cfg, daemonCacheDir, errCh, &provisionerdWaitGroup,
)
if err != nil {
return xerrors.Errorf("create provisioner daemon: %w", err)
Expand Down Expand Up @@ -1177,7 +1177,6 @@ func newProvisionerDaemon(
cfg *codersdk.DeploymentValues,
cacheDir string,
errCh chan error,
dev bool,
wg *sync.WaitGroup,
) (srv *provisionerd.Server, err error) {
ctx, cancel := context.WithCancel(ctx)
Expand All @@ -1192,53 +1191,14 @@ func newProvisionerDaemon(
return nil, xerrors.Errorf("mkdir %q: %w", cacheDir, err)
}

tfDir := filepath.Join(cacheDir, "tf")
err = os.MkdirAll(tfDir, 0o700)
if err != nil {
return nil, xerrors.Errorf("mkdir terraform dir: %w", err)
}

tracer := coderAPI.TracerProvider.Tracer(tracing.TracerName)
terraformClient, terraformServer := provisionersdk.MemTransportPipe()
wg.Add(1)
go func() {
defer wg.Done()
<-ctx.Done()
_ = terraformClient.Close()
_ = terraformServer.Close()
}()
wg.Add(1)
go func() {
defer wg.Done()
defer cancel()

err := terraform.Serve(ctx, &terraform.ServeOptions{
ServeOptions: &provisionersdk.ServeOptions{
Listener: terraformServer,
},
CachePath: tfDir,
Logger: logger,
Tracer: tracer,
})
if err != nil && !xerrors.Is(err, context.Canceled) {
select {
case errCh <- err:
default:
}
}
}()

workDir := filepath.Join(cacheDir, "work")
err = os.MkdirAll(workDir, 0o700)
if err != nil {
return nil, xerrors.Errorf("mkdir work dir: %w", err)
}

provisioners := provisionerd.Provisioners{
string(database.ProvisionerTypeTerraform): sdkproto.NewDRPCProvisionerClient(terraformClient),
}
// include echo provisioner when in dev mode
if dev {
provisioners := provisionerd.Provisioners{}
if cfg.Provisioner.DaemonsEcho {
echoClient, echoServer := provisionersdk.MemTransportPipe()
wg.Add(1)
go func() {
Expand All @@ -1261,7 +1221,46 @@ func newProvisionerDaemon(
}
}()
provisioners[string(database.ProvisionerTypeEcho)] = sdkproto.NewDRPCProvisionerClient(echoClient)
} else {
tfDir := filepath.Join(cacheDir, "tf")
err = os.MkdirAll(tfDir, 0o700)
if err != nil {
return nil, xerrors.Errorf("mkdir terraform dir: %w", err)
}

tracer := coderAPI.TracerProvider.Tracer(tracing.TracerName)
terraformClient, terraformServer := provisionersdk.MemTransportPipe()
wg.Add(1)
go func() {
defer wg.Done()
<-ctx.Done()
_ = terraformClient.Close()
_ = terraformServer.Close()
}()
wg.Add(1)
go func() {
defer wg.Done()
defer cancel()

err := terraform.Serve(ctx, &terraform.ServeOptions{
ServeOptions: &provisionersdk.ServeOptions{
Listener: terraformServer,
},
CachePath: tfDir,
Logger: logger,
Tracer: tracer,
})
if err != nil && !xerrors.Is(err, context.Canceled) {
select {
case errCh <- err:
default:
}
}
}()

provisioners[string(database.ProvisionerTypeTerraform)] = sdkproto.NewDRPCProvisionerClient(terraformClient)
}

debounce := time.Second
return provisionerd.New(func(ctx context.Context) (proto.DRPCProvisionerDaemonClient, error) {
// This debounces calls to listen every second. Read the comment
Expand Down
4 changes: 4 additions & 0 deletions cli/testdata/server-config.yaml.golden
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,10 @@ provisioning:
# state for a long time, consider increasing this.
# (default: 3, type: int)
daemons: 3
# Whether to use echo provisioner daemons instead of Terraform. This is for E2E
# tests.
# (default: false, type: bool)
daemonsEcho: false
# Time to wait before polling for a new job.
# (default: 1s, type: duration)
daemonPollInterval: 1s
Expand Down
3 changes: 3 additions & 0 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions codersdk/deployment.go
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@ type GitAuthConfig struct {

type ProvisionerConfig struct {
Daemons clibase.Int64 `json:"daemons" typescript:",notnull"`
DaemonsEcho clibase.Bool `json:"daemons_echo" typescript:",notnull"`
DaemonPollInterval clibase.Duration `json:"daemon_poll_interval" typescript:",notnull"`
DaemonPollJitter clibase.Duration `json:"daemon_poll_jitter" typescript:",notnull"`
ForceCancelInterval clibase.Duration `json:"force_cancel_interval" typescript:",notnull"`
Expand Down Expand Up @@ -1093,6 +1094,17 @@ when required by your organization's security policy.`,
Group: &deploymentGroupProvisioning,
YAML: "daemons",
},
{
Name: "Echo Provisioner",
Description: "Whether to use echo provisioner daemons instead of Terraform. This is for E2E tests.",
Flag: "provisioner-daemons-echo",
Env: "CODER_PROVISIONER_DAEMONS_ECHO",
Hidden: true,
Default: "false",
Value: &c.Provisioner.DaemonsEcho,
Group: &deploymentGroupProvisioning,
YAML: "daemonsEcho",
},
{
Name: "Poll Interval",
Description: "Time to wait before polling for a new job.",
Expand Down
1 change: 1 addition & 0 deletions docs/api/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
"daemons": 0,
"daemons_echo": true,
"force_cancel_interval": 0
},
"proxy_health_status_interval": 0,
Expand Down
4 changes: 4 additions & 0 deletions docs/api/schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -1960,6 +1960,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
"daemons": 0,
"daemons_echo": true,
"force_cancel_interval": 0
},
"proxy_health_status_interval": 0,
Expand Down Expand Up @@ -2289,6 +2290,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
"daemons": 0,
"daemons_echo": true,
"force_cancel_interval": 0
},
"proxy_health_status_interval": 0,
Expand Down Expand Up @@ -3125,6 +3127,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
"daemons": 0,
"daemons_echo": true,
"force_cancel_interval": 0
}
```
Expand All @@ -3136,6 +3139,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| `daemon_poll_interval` | integer | false | | |
| `daemon_poll_jitter` | integer | false | | |
| `daemons` | integer | false | | |
| `daemons_echo` | boolean | false | | |
| `force_cancel_interval` | integer | false | | |

## codersdk.ProvisionerDaemon
Expand Down
2 changes: 1 addition & 1 deletion examples/templates/docker/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ terraform {
required_providers {
coder = {
source = "coder/coder"
version = "~> 0.7.0"
version = "~> 0.8.3"
}
docker = {
source = "kreuzwerker/docker"
Expand Down
4 changes: 4 additions & 0 deletions site/.eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ storybook-static/
test-results/*
e2e/test-results/*
e2e/states/*.json
e2e/.auth.json
playwright-report/*
.swc
dist/
Expand Down Expand Up @@ -74,3 +75,6 @@ stats/

# Testdata shouldn't be formatted.
../scripts/apitypings/testdata/**/*.ts

# Generated files shouldn't be formatted.
e2e/provisionerGenerated.ts
4 changes: 4 additions & 0 deletions site/.prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ storybook-static/
test-results/*
e2e/test-results/*
e2e/states/*.json
e2e/.auth.json
playwright-report/*
.swc
dist/
Expand Down Expand Up @@ -74,3 +75,6 @@ stats/

# Testdata shouldn't be formatted.
../scripts/apitypings/testdata/**/*.ts

# Generated files shouldn't be formatted.
e2e/provisionerGenerated.ts
18 changes: 18 additions & 0 deletions site/e2e/global.setup.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { test, expect } from "@playwright/test"
import * as constants from "./constants"
import { STORAGE_STATE } from "./playwright.config"
import { Language } from "../src/components/CreateUserForm/CreateUserForm"

test("create first user", async ({ page }) => {
await page.goto("/", { waitUntil: "networkidle" })

await page.getByLabel(Language.usernameLabel).fill(constants.username)
await page.getByLabel(Language.emailLabel).fill(constants.email)
await page.getByLabel(Language.passwordLabel).fill(constants.password)
await page.getByTestId("trial").click()
await page.getByTestId("create").click()

await expect(page).toHaveURL("/workspaces")

await page.context().storageState({ path: STORAGE_STATE })
})
35 changes: 0 additions & 35 deletions site/e2e/globalSetup.ts

This file was deleted.

Loading