Skip to content

fix: Use in-memory filesystem for echo provisioner tests #2408

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.

Sign up for GitHub

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 5 commits into from
Jun 16, 2022
Merged

fix: Use in-memory filesystem for echo provisioner tests #2408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
614834e
fix: Use in-memory filesystem for echo provisioner tests
kylecarbs Jun 16, 2022
6f43117
test: Increase timeouts to reduce flakes
kylecarbs Jun 16, 2022
cea630b
Merge branch 'main' into testtimes
kylecarbs Jun 16, 2022
826fd46
Merge branch 'testtimes' into reduceio
kylecarbs Jun 16, 2022
a0fc73b
Merge branch 'main' into reduceio
kylecarbs Jun 16, 2022
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
3 changes: 2 additions & 1 deletion cli/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/pion/turn/v2"
"github.com/pion/webrtc/v3"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/spf13/afero"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ❤️ this library!

"github.com/spf13/cobra"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
"golang.org/x/oauth2"
Expand Down Expand Up @@ -550,7 +551,7 @@ func newProvisionerDaemon(ctx context.Context, coderAPI *coderd.API,
if dev {
echoClient, echoServer := provisionersdk.TransportPipe()
go func() {
err := echo.Serve(ctx, &provisionersdk.ServeOptions{Listener: echoServer})
err := echo.Serve(ctx, afero.NewOsFs(), &provisionersdk.ServeOptions{Listener: echoServer})
if err != nil {
errChan <- err
}
Expand Down
12 changes: 8 additions & 4 deletions coderd/coderdtest/coderdtest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import (
"testing"
"time"

"github.com/spf13/afero"

"github.com/coder/coder/coderd/rbac"
"github.com/coder/coder/coderd/util/ptr"

Expand Down Expand Up @@ -190,18 +192,20 @@ func NewProvisionerDaemon(t *testing.T, coderAPI *coderd.API) io.Closer {
_ = echoServer.Close()
cancelFunc()
})
fs := afero.NewMemMapFs()
go func() {
err := echo.Serve(ctx, &provisionersdk.ServeOptions{
err := echo.Serve(ctx, fs, &provisionersdk.ServeOptions{
Listener: echoServer,
})
assert.NoError(t, err)
}()

closer := provisionerd.New(coderAPI.ListenProvisionerDaemon, &provisionerd.Options{
Filesystem: fs,
Logger: slogtest.Make(t, nil).Named("provisionerd").Leveled(slog.LevelDebug),
PollInterval: 50 * time.Millisecond,
UpdateInterval: 250 * time.Millisecond,
ForceCancelInterval: 250 * time.Millisecond,
PollInterval: 10 * time.Millisecond,
UpdateInterval: 25 * time.Millisecond,
ForceCancelInterval: 25 * time.Millisecond,
Provisioners: provisionerd.Provisioners{
string(database.ProvisionerTypeEcho): proto.NewDRPCProvisionerClient(provisionersdk.Conn(echoClient)),
},
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ require (
github.com/rcrowley/go-metrics v0.0.0-20200313005456-10cdbea86bc0 // indirect
github.com/rivo/uniseg v0.2.0 // indirect
github.com/sirupsen/logrus v1.8.1 // indirect
github.com/spf13/afero v1.8.2 // indirect
github.com/spf13/afero v1.8.2
github.com/spf13/cast v1.5.0 // indirect
github.com/spf13/jwalterweatherman v1.1.0 // indirect
github.com/tadvi/systray v0.0.0-20190226123456-11a2b8fa57af // indirect
Expand Down
25 changes: 15 additions & 10 deletions provisioner/echo/serve.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ import (
"bytes"
"context"
"fmt"
"os"
"path/filepath"

"golang.org/x/xerrors"
protobuf "google.golang.org/protobuf/proto"

"github.com/spf13/afero"

"github.com/coder/coder/provisionersdk"
"github.com/coder/coder/provisionersdk/proto"
)
Expand All @@ -31,28 +32,32 @@ var (
)

// Serve starts the echo provisioner.
func Serve(ctx context.Context, options *provisionersdk.ServeOptions) error {
return provisionersdk.Serve(ctx, &echo{}, options)
func Serve(ctx context.Context, filesystem afero.Fs, options *provisionersdk.ServeOptions) error {
return provisionersdk.Serve(ctx, &echo{
filesystem: filesystem,
}, options)
}

// The echo provisioner serves as a dummy provisioner primarily
// used for testing. It echos responses from JSON files in the
// format %d.protobuf. It's used for testing.
type echo struct{}
type echo struct {
filesystem afero.Fs
}

// Parse reads requests from the provided directory to stream responses.
func (*echo) Parse(request *proto.Parse_Request, stream proto.DRPCProvisioner_ParseStream) error {
func (e *echo) Parse(request *proto.Parse_Request, stream proto.DRPCProvisioner_ParseStream) error {
for index := 0; ; index++ {
path := filepath.Join(request.Directory, fmt.Sprintf("%d.parse.protobuf", index))
_, err := os.Stat(path)
_, err := e.filesystem.Stat(path)
if err != nil {
if index == 0 {
// Error if nothing is around to enable failed states.
return xerrors.New("no state")
}
break
}
data, err := os.ReadFile(path)
data, err := afero.ReadFile(e.filesystem, path)
if err != nil {
return xerrors.Errorf("read file %q: %w", path, err)
}
Expand All @@ -71,7 +76,7 @@ func (*echo) Parse(request *proto.Parse_Request, stream proto.DRPCProvisioner_Pa
}

// Provision reads requests from the provided directory to stream responses.
func (*echo) Provision(stream proto.DRPCProvisioner_ProvisionStream) error {
func (e *echo) Provision(stream proto.DRPCProvisioner_ProvisionStream) error {
msg, err := stream.Recv()
if err != nil {
return err
Expand All @@ -83,15 +88,15 @@ func (*echo) Provision(stream proto.DRPCProvisioner_ProvisionStream) error {
extension = ".dry.protobuf"
}
path := filepath.Join(request.Directory, fmt.Sprintf("%d.provision"+extension, index))
_, err := os.Stat(path)
_, err := e.filesystem.Stat(path)
if err != nil {
if index == 0 {
// Error if nothing is around to enable failed states.
return xerrors.New("no state")
}
break
}
data, err := os.ReadFile(path)
data, err := afero.ReadFile(e.filesystem, path)
if err != nil {
return xerrors.Errorf("read file %q: %w", path, err)
}
Expand Down
12 changes: 7 additions & 5 deletions provisioner/echo/serve_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"path/filepath"
"testing"

"github.com/spf13/afero"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

Expand All @@ -20,6 +21,7 @@ import (
func TestEcho(t *testing.T) {
t.Parallel()

fs := afero.NewMemMapFs()
// Create an in-memory provisioner to communicate with.
client, server := provisionersdk.TransportPipe()
ctx, cancelFunc := context.WithCancel(context.Background())
Expand All @@ -29,7 +31,7 @@ func TestEcho(t *testing.T) {
cancelFunc()
})
go func() {
err := echo.Serve(ctx, &provisionersdk.ServeOptions{
err := echo.Serve(ctx, fs, &provisionersdk.ServeOptions{
Listener: server,
})
assert.NoError(t, err)
Expand Down Expand Up @@ -59,7 +61,7 @@ func TestEcho(t *testing.T) {
})
require.NoError(t, err)
client, err := api.Parse(ctx, &proto.Parse_Request{
Directory: unpackTar(t, data),
Directory: unpackTar(t, fs, data),
})
require.NoError(t, err)
log, err := client.Recv()
Expand Down Expand Up @@ -98,7 +100,7 @@ func TestEcho(t *testing.T) {
err = client.Send(&proto.Provision_Request{
Type: &proto.Provision_Request_Start{
Start: &proto.Provision_Start{
Directory: unpackTar(t, data),
Directory: unpackTar(t, fs, data),
},
},
})
Expand All @@ -113,7 +115,7 @@ func TestEcho(t *testing.T) {
})
}

func unpackTar(t *testing.T, data []byte) string {
func unpackTar(t *testing.T, fs afero.Fs, data []byte) string {
directory := t.TempDir()
reader := tar.NewReader(bytes.NewReader(data))
for {
Expand All @@ -123,7 +125,7 @@ func unpackTar(t *testing.T, data []byte) string {
}
// #nosec
path := filepath.Join(directory, header.Name)
file, err := os.OpenFile(path, os.O_CREATE|os.O_RDWR, 0600)
file, err := fs.OpenFile(path, os.O_CREATE|os.O_RDWR, 0600)
require.NoError(t, err)
_, err = io.CopyN(file, reader, 1<<20)
require.ErrorIs(t, err, io.EOF)
Expand Down
17 changes: 11 additions & 6 deletions provisionerd/provisionerd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (

"github.com/google/uuid"
"github.com/hashicorp/yamux"
"github.com/spf13/afero"
"go.uber.org/atomic"
"golang.org/x/xerrors"

Expand Down Expand Up @@ -45,7 +46,8 @@ type Provisioners map[string]sdkproto.DRPCProvisionerClient

// Options provides customizations to the behavior of a provisioner daemon.
type Options struct {
Logger slog.Logger
Filesystem afero.Fs
Logger slog.Logger

ForceCancelInterval time.Duration
UpdateInterval time.Duration
Expand All @@ -65,6 +67,9 @@ func New(clientDialer Dialer, opts *Options) *Server {
if opts.ForceCancelInterval == 0 {
opts.ForceCancelInterval = time.Minute
}
if opts.Filesystem == nil {
opts.Filesystem = afero.NewOsFs()
}
ctx, ctxCancel := context.WithCancel(context.Background())
daemon := &Server{
clientDialer: clientDialer,
Expand Down Expand Up @@ -303,7 +308,7 @@ func (p *Server) runJob(ctx context.Context, job *proto.AcquiredJob) {
defer func() {
// Cleanup the work directory after execution.
for attempt := 0; attempt < 5; attempt++ {
err := os.RemoveAll(p.opts.WorkDirectory)
err := p.opts.Filesystem.RemoveAll(p.opts.WorkDirectory)
if err != nil {
// On Windows, open files cannot be removed.
// When the provisioner daemon is shutting down,
Expand All @@ -326,7 +331,7 @@ func (p *Server) runJob(ctx context.Context, job *proto.AcquiredJob) {
return
}

err := os.MkdirAll(p.opts.WorkDirectory, 0700)
err := p.opts.Filesystem.MkdirAll(p.opts.WorkDirectory, 0700)
if err != nil {
p.failActiveJobf("create work directory %q: %s", p.opts.WorkDirectory, err)
return
Expand Down Expand Up @@ -374,14 +379,14 @@ func (p *Server) runJob(ctx context.Context, job *proto.AcquiredJob) {
}
switch header.Typeflag {
case tar.TypeDir:
err = os.MkdirAll(headerPath, mode)
err = p.opts.Filesystem.MkdirAll(headerPath, mode)
if err != nil {
p.failActiveJobf("mkdir %q: %s", headerPath, err)
return
}
p.opts.Logger.Debug(context.Background(), "extracted directory", slog.F("path", headerPath))
case tar.TypeReg:
file, err := os.OpenFile(headerPath, os.O_CREATE|os.O_RDWR, mode)
file, err := p.opts.Filesystem.OpenFile(headerPath, os.O_CREATE|os.O_RDWR, mode)
if err != nil {
p.failActiveJobf("create file %q (mode %s): %s", headerPath, mode, err)
return
Expand Down Expand Up @@ -470,7 +475,7 @@ func (p *Server) runReadmeParse(ctx context.Context, job *proto.AcquiredJob) {
return
}

fi, err := os.ReadFile(path.Join(p.opts.WorkDirectory, ReadmeFile))
fi, err := afero.ReadFile(p.opts.Filesystem, path.Join(p.opts.WorkDirectory, ReadmeFile))
if err != nil {
_, err := client.UpdateJob(ctx, &proto.UpdateJobRequest{
JobId: job.GetJobId(),
Expand Down