Move filepool resources to their own package

The filesystem package was getting crowded, this commit moves filepool
related obejcts to their own package.

Author: meroton-benjamin

cmd/bb_noop_worker/BUILD.bazel

@@ -9,7 +9,7 @@ go_library(
     deps = [
         "//pkg/blobstore",
         "//pkg/builder",
-        "//pkg/filesystem",
+        "//pkg/filesystem/pool",
         "//pkg/proto/configuration/bb_noop_worker",
         "//pkg/proto/remoteworker",
         "@com_github_buildbarn_bb_storage//pkg/blobstore/configuration",

cmd/bb_noop_worker/main.go

@@ -7,7 +7,7 @@ import (
 
 	re_blobstore "github.com/buildbarn/bb-remote-execution/pkg/blobstore"
 	"github.com/buildbarn/bb-remote-execution/pkg/builder"
-	re_filesystem "github.com/buildbarn/bb-remote-execution/pkg/filesystem"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	"github.com/buildbarn/bb-remote-execution/pkg/proto/configuration/bb_noop_worker"
 	"github.com/buildbarn/bb-remote-execution/pkg/proto/remoteworker"
 	blobstore_configuration "github.com/buildbarn/bb-storage/pkg/blobstore/configuration"
@@ -76,7 +76,7 @@ func main() {
 				contentAddressableStorage,
 				int(configuration.MaximumMessageSizeBytes),
 				browserURL),
-			re_filesystem.EmptyFilePool,
+			pool.EmptyFilePool,
 			clock.SystemClock,
 			configuration.WorkerId,
 			instanceNamePrefix,

cmd/bb_worker/BUILD.bazel

@@ -16,7 +16,7 @@ go_library(
         "//pkg/cas",
         "//pkg/cleaner",
         "//pkg/clock",
-        "//pkg/filesystem",
+        "//pkg/filesystem/pool",
         "//pkg/filesystem/virtual",
         "//pkg/filesystem/virtual/configuration",
         "//pkg/proto/completedactionlogger",

cmd/bb_worker/main.go

@@ -18,7 +18,7 @@ import (
 	"github.com/buildbarn/bb-remote-execution/pkg/cas"
 	"github.com/buildbarn/bb-remote-execution/pkg/cleaner"
 	re_clock "github.com/buildbarn/bb-remote-execution/pkg/clock"
-	re_filesystem "github.com/buildbarn/bb-remote-execution/pkg/filesystem"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/virtual"
 	virtual_configuration "github.com/buildbarn/bb-remote-execution/pkg/filesystem/virtual/configuration"
 	cal_proto "github.com/buildbarn/bb-remote-execution/pkg/proto/completedactionlogger"
@@ -76,7 +76,7 @@ func main() {
 		// currently only used by the virtual file system to store
 		// output files of build actions. Going forward, this may be
 		// used to store core dumps generated by build actions as well.
-		filePool, err := re_filesystem.NewFilePoolFromConfiguration(configuration.FilePool)
+		filePool, err := pool.NewFilePoolFromConfiguration(configuration.FilePool)
 		if err != nil {
 			return util.StatusWrap(err, "Failed to create file pool")
 		}
@@ -218,7 +218,7 @@ func main() {
 				virtualBuildDirectory = virtual.NewInMemoryPrepopulatedDirectory(
 					virtual.NewHandleAllocatingFileAllocator(
 						virtual.NewPoolBackedFileAllocator(
-							re_filesystem.EmptyFilePool,
+							pool.EmptyFilePool,
 							util.DefaultErrorLogger),
 						handleAllocator),
 					symlinkFactory,
@@ -466,7 +466,7 @@ func main() {
 					buildClient := builder.NewBuildClient(
 						schedulerClient,
 						buildExecutor,
-						re_filesystem.NewQuotaEnforcingFilePool(
+						pool.NewQuotaEnforcingFilePool(
 							filePool,
 							runnerConfiguration.MaximumFilePoolFileCount,
 							runnerConfiguration.MaximumFilePoolSizeBytes),

internal/mock/BUILD.bazel

@@ -172,7 +172,6 @@ gomock(
     out = "filesystem_re.go",
     interfaces = [
         "DirectoryOpener",
-        "FilePool",
         "SectorAllocator",
     ],
     library = "//pkg/filesystem",
@@ -181,6 +180,18 @@ gomock(
     package = "mock",
 )
 
+gomock(
+    name = "filesystem_filepool",
+    out = "filesystem_filepool.go",
+    interfaces = [
+        "FilePool",
+    ],
+    library = "//pkg/filesystem/pool",
+    mockgen_model_library = "@org_uber_go_mock//mockgen/model",
+    mockgen_tool = "@org_uber_go_mock//mockgen",
+    package = "mock",
+)
+
 gomock(
     name = "filesystem_virtual",
     out = "filesystem_virtual.go",
@@ -411,6 +422,7 @@ go_library(
         ":completedactionlogger.go",
         ":filesystem.go",
         ":filesystem_access.go",
+        ":filesystem_filepool.go",
         ":filesystem_re.go",
         ":filesystem_virtual.go",
         ":grpc_go.go",
@@ -445,6 +457,7 @@ go_library(
         "//pkg/cleaner",
         "//pkg/filesystem",
         "//pkg/filesystem/access",
+        "//pkg/filesystem/pool",
         "//pkg/filesystem/virtual",
         "//pkg/proto/bazeloutputservice",
         "//pkg/proto/buildqueuestate",

pkg/builder/BUILD.bazel

@@ -36,8 +36,8 @@ go_library(
         "//pkg/cas",
         "//pkg/cleaner",
         "//pkg/clock",
-        "//pkg/filesystem",
         "//pkg/filesystem/access",
+        "//pkg/filesystem/pool",
         "//pkg/filesystem/virtual",
         "//pkg/proto/cas",
         "//pkg/proto/completedactionlogger",
@@ -104,8 +104,8 @@ go_test(
         "//internal/mock",
         "//pkg/cleaner",
         "//pkg/clock",
-        "//pkg/filesystem",
         "//pkg/filesystem/access",
+        "//pkg/filesystem/pool",
         "//pkg/proto/cas",
         "//pkg/proto/completedactionlogger",
         "//pkg/proto/remoteworker",

pkg/builder/build_client.go

@@ -6,7 +6,7 @@ import (
 	"time"
 
 	remoteexecution "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
-	"github.com/buildbarn/bb-remote-execution/pkg/filesystem"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	"github.com/buildbarn/bb-remote-execution/pkg/proto/remoteworker"
 	"github.com/buildbarn/bb-storage/pkg/clock"
 	"github.com/buildbarn/bb-storage/pkg/digest"
@@ -28,7 +28,7 @@ type BuildClient struct {
 	// Constant fields.
 	scheduler           remoteworker.OperationQueueClient
 	buildExecutor       BuildExecutor
-	filePool            filesystem.FilePool
+	filePool            pool.FilePool
 	clock               clock.Clock
 	instanceNamePrefix  digest.InstanceName
 	instanceNamePatcher digest.InstanceNamePatcher
@@ -45,7 +45,7 @@ type BuildClient struct {
 
 // NewBuildClient creates a new BuildClient instance that is set to the
 // initial state (i.e., being idle).
-func NewBuildClient(scheduler remoteworker.OperationQueueClient, buildExecutor BuildExecutor, filePool filesystem.FilePool, clock clock.Clock, workerID map[string]string, instanceNamePrefix digest.InstanceName, platform *remoteexecution.Platform, sizeClass uint32) *BuildClient {
+func NewBuildClient(scheduler remoteworker.OperationQueueClient, buildExecutor BuildExecutor, filePool pool.FilePool, clock clock.Clock, workerID map[string]string, instanceNamePrefix digest.InstanceName, platform *remoteexecution.Platform, sizeClass uint32) *BuildClient {
 	return &BuildClient{
 		scheduler:           scheduler,
 		buildExecutor:       buildExecutor,

pkg/builder/build_directory.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"os"
 
-	re_filesystem "github.com/buildbarn/bb-remote-execution/pkg/filesystem"
 	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/access"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	"github.com/buildbarn/bb-storage/pkg/digest"
 	"github.com/buildbarn/bb-storage/pkg/filesystem"
 	"github.com/buildbarn/bb-storage/pkg/filesystem/path"
@@ -36,7 +36,7 @@ type BuildDirectory interface {
 	// errors. Implementations of BuildDirectory are free to let
 	// this be a no-op, with the disadvantage that they cannot apply
 	// resource limits or provide rich I/O error messages.
-	InstallHooks(filePool re_filesystem.FilePool, errorLogger util.ErrorLogger)
+	InstallHooks(filePool pool.FilePool, errorLogger util.ErrorLogger)
 
 	// Recursively merges the contents of a Directory stored in the
 	// Content Addressable Storage into a local directory. If this

pkg/builder/build_executor.go

@@ -4,8 +4,8 @@ import (
 	"context"
 
 	remoteexecution "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
-	"github.com/buildbarn/bb-remote-execution/pkg/filesystem"
 	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/access"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	"github.com/buildbarn/bb-remote-execution/pkg/proto/remoteworker"
 	"github.com/buildbarn/bb-storage/pkg/digest"
 
@@ -67,5 +67,5 @@ func GetResultAndGRPCCodeFromExecuteResponse(response *remoteexecution.ExecuteRe
 // requests and yield an execute response.
 type BuildExecutor interface {
 	CheckReadiness(ctx context.Context) error
-	Execute(ctx context.Context, filePool filesystem.FilePool, monitor access.UnreadDirectoryMonitor, digestFunction digest.Function, request *remoteworker.DesiredState_Executing, executionStateUpdates chan<- *remoteworker.CurrentState_Executing) *remoteexecution.ExecuteResponse
+	Execute(ctx context.Context, filePool pool.FilePool, monitor access.UnreadDirectoryMonitor, digestFunction digest.Function, request *remoteworker.DesiredState_Executing, executionStateUpdates chan<- *remoteworker.CurrentState_Executing) *remoteexecution.ExecuteResponse
 }

pkg/builder/caching_build_executor.go

@@ -5,8 +5,8 @@ import (
 	"net/url"
 
 	remoteexecution "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
-	"github.com/buildbarn/bb-remote-execution/pkg/filesystem"
 	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/access"
+	"github.com/buildbarn/bb-remote-execution/pkg/filesystem/pool"
 	cas_proto "github.com/buildbarn/bb-remote-execution/pkg/proto/cas"
 	"github.com/buildbarn/bb-remote-execution/pkg/proto/remoteworker"
 	re_util "github.com/buildbarn/bb-remote-execution/pkg/util"
@@ -42,7 +42,7 @@ func NewCachingBuildExecutor(base BuildExecutor, contentAddressableStorage, acti
 	}
 }
 
-func (be *cachingBuildExecutor) Execute(ctx context.Context, filePool filesystem.FilePool, monitor access.UnreadDirectoryMonitor, digestFunction digest.Function, request *remoteworker.DesiredState_Executing, executionStateUpdates chan<- *remoteworker.CurrentState_Executing) *remoteexecution.ExecuteResponse {
+func (be *cachingBuildExecutor) Execute(ctx context.Context, filePool pool.FilePool, monitor access.UnreadDirectoryMonitor, digestFunction digest.Function, request *remoteworker.DesiredState_Executing, executionStateUpdates chan<- *remoteworker.CurrentState_Executing) *remoteexecution.ExecuteResponse {
 	response := be.BuildExecutor.Execute(ctx, filePool, monitor, digestFunction, request, executionStateUpdates)
 	if actionDigest, err := digestFunction.NewDigestFromProto(request.ActionDigest); err != nil {
 		attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to extract digest for action"))