Move log persister for testing to separate package

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

Author: Warashi

pkg/app/pipedv1/plugin/kubernetes/deployment/server_test.go

@@ -21,7 +21,6 @@ import (
 	"path"
 	"path/filepath"
 	"testing"
-	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -38,54 +37,10 @@ import (
 	config "github.com/pipe-cd/pipecd/pkg/configv1"
 	"github.com/pipe-cd/pipecd/pkg/model"
 	"github.com/pipe-cd/pipecd/pkg/plugin/api/v1alpha1/deployment"
-	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister"
+	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister/logpersistertest"
 	"github.com/pipe-cd/pipecd/pkg/plugin/toolregistry/toolregistrytest"
 )
 
-// newTestLogPersister creates a new testLogPersister for testing.
-//
-// TODO: move to a common package
-func newTestLogPersister(t *testing.T) testLogPersister {
-	return testLogPersister{t}
-}
-
-// testLogPersister implements logpersister for testing.
-type testLogPersister struct {
-	t *testing.T
-}
-
-func (lp testLogPersister) StageLogPersister(deploymentID, stageID string) logpersister.StageLogPersister {
-	return lp
-}
-
-func (lp testLogPersister) Write(log []byte) (int, error) {
-	// Write the log to the test logger
-	lp.t.Log(string(log))
-	return 0, nil
-}
-func (lp testLogPersister) Info(log string) {
-	lp.t.Log("INFO", log)
-}
-func (lp testLogPersister) Infof(format string, a ...interface{}) {
-	lp.t.Logf("INFO "+format, a...)
-}
-func (lp testLogPersister) Success(log string) {
-	lp.t.Log("SUCCESS", log)
-}
-func (lp testLogPersister) Successf(format string, a ...interface{}) {
-	lp.t.Logf("SUCCESS "+format, a...)
-}
-func (lp testLogPersister) Error(log string) {
-	lp.t.Log("ERROR", log)
-}
-func (lp testLogPersister) Errorf(format string, a ...interface{}) {
-	lp.t.Logf("ERROR "+format, a...)
-}
-func (lp testLogPersister) Complete(timeout time.Duration) error {
-	lp.t.Logf("Complete stage log persister with timeout: %v", timeout)
-	return nil
-}
-
 // TODO: move to a common package
 func examplesDir() string {
 	d, _ := os.Getwd()
@@ -191,7 +146,7 @@ func TestDeploymentService_executeK8sSyncStage(t *testing.T) {
 		},
 	}
 
-	svc := NewDeploymentService(pluginCfg, zaptest.NewLogger(t), testRegistry, newTestLogPersister(t))
+	svc := NewDeploymentService(pluginCfg, zaptest.NewLogger(t), testRegistry, logpersistertest.NewTestLogPersister(t))
 	resp, err := svc.ExecuteStage(ctx, req)
 
 	require.NoError(t, err)

pkg/plugin/logpersister/logpersistertest/logpersister.go

@@ -0,0 +1,64 @@
+// Copyright 2024 The PipeCD Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package logpersistertest
+
+import (
+	"testing"
+	"time"
+
+	"github.com/pipe-cd/pipecd/pkg/plugin/logpersister"
+)
+
+// NewTestLogPersister creates a new testLogPersister for testing.
+func NewTestLogPersister(t *testing.T) TestLogPersister {
+	return TestLogPersister{t}
+}
+
+// TestLogPersister implements logpersister for testing.
+type TestLogPersister struct {
+	t *testing.T
+}
+
+func (lp TestLogPersister) StageLogPersister(deploymentID, stageID string) logpersister.StageLogPersister {
+	return lp
+}
+
+func (lp TestLogPersister) Write(log []byte) (int, error) {
+	// Write the log to the test logger
+	lp.t.Log(string(log))
+	return 0, nil
+}
+func (lp TestLogPersister) Info(log string) {
+	lp.t.Log("INFO", log)
+}
+func (lp TestLogPersister) Infof(format string, a ...interface{}) {
+	lp.t.Logf("INFO "+format, a...)
+}
+func (lp TestLogPersister) Success(log string) {
+	lp.t.Log("SUCCESS", log)
+}
+func (lp TestLogPersister) Successf(format string, a ...interface{}) {
+	lp.t.Logf("SUCCESS "+format, a...)
+}
+func (lp TestLogPersister) Error(log string) {
+	lp.t.Log("ERROR", log)
+}
+func (lp TestLogPersister) Errorf(format string, a ...interface{}) {
+	lp.t.Logf("ERROR "+format, a...)
+}
+func (lp TestLogPersister) Complete(timeout time.Duration) error {
+	lp.t.Logf("Complete stage log persister with timeout: %v", timeout)
+	return nil
+}