Skip to content
Open
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
51 changes: 49 additions & 2 deletions pkg/backend/build/builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,39 @@ func (s *BuilderTestSuite) TestNewBuilder() {
}
}

// recordingStrategy is a hand-written OutputStrategy used by TestBuildLayer.
//
// BuildLayer hands OutputLayer a live *io.PipeReader whose background tar
// writer goroutine is mid-write. The generated testify mock formats every
// argument with fmt (via mock.Arguments.Diff) when matching the call, which
// reflects into the pipe's internal state concurrently with that writer -- a
// data race reported under `go test -race`. This fake reads the reader like
// the real strategies do, which avoids the reflection and unblocks the writer
// goroutine.
type recordingStrategy struct {
OutputStrategy // OutputConfig/OutputManifest are unused by this test.

desc ocispec.Descriptor
err error

called bool
mediaType string
relPath string
destPath string
size int64
gotReader bool
}

func (r *recordingStrategy) OutputLayer(_ context.Context, mediaType, relPath, destPath, _ string, size int64, reader io.Reader, _ hooks.Hooks) (ocispec.Descriptor, error) {
r.called = true
r.mediaType, r.relPath, r.destPath, r.size = mediaType, relPath, destPath, size
r.gotReader = reader != nil
if reader != nil {
_, _ = io.Copy(io.Discard, reader)
}
return r.desc, r.err
}

func (s *BuilderTestSuite) TestBuildLayer() {
s.Run("successful build layer", func() {
expectedDesc := ocispec.Descriptor{
Expand All @@ -123,11 +156,25 @@ func (s *BuilderTestSuite) TestBuildLayer() {
Size: 100,
}

s.mockOutputStrategy.On("OutputLayer", mock.Anything, "test/media-type.tar", "test-file.txt", "", mock.AnythingOfType("string"), mock.AnythingOfType("int64"), mock.AnythingOfType("*io.PipeReader"), mock.Anything).
Return(expectedDesc, nil)
// Use a hand-written strategy instead of the testify mock: BuildLayer
// passes OutputLayer a live *io.PipeReader, and the mock's argument
// diffing formats it with fmt, racing with the pipe's writer goroutine.
strategy := &recordingStrategy{
OutputStrategy: s.mockOutputStrategy,
desc: expectedDesc,
}
s.builder.strategy = strategy
defer func() {
s.builder.strategy = s.mockOutputStrategy
}()

desc, err := s.builder.BuildLayer(context.Background(), "test/media-type.tar", s.tempDir, s.tempFile, "", hooks.NewHooks())
s.NoError(err)
s.True(strategy.called)
s.Equal("test/media-type.tar", strategy.mediaType)
s.Equal("test-file.txt", strategy.relPath)
s.Equal("", strategy.destPath)
s.True(strategy.gotReader)
s.Equal(expectedDesc.MediaType, desc.MediaType)
s.Equal(expectedDesc.Digest, desc.Digest)
s.Equal(expectedDesc.Size, desc.Size)
Expand Down