Merge pull request #1510 from saschagrunert/godot

Fix `godot` linter

Author: k8s-ci-robot

.golangci.yml

@@ -20,6 +20,7 @@ linters:
     - gocheckcompilerdirectives
     - gochecksumtype
     - gocritic
+    - godot
     - gofmt
     - goimports
     - gosmopolitan
@@ -80,7 +81,6 @@ linters:
     # - gocognit
     # - goconst
     # - gocyclo
-    # - godot
     # - godox
     # - gofumpt
     # - goheader

cmd/crictl/attach.go

@@ -82,7 +82,7 @@ var runtimeAttachCommand = &cli.Command{
 	},
 }
 
-// Attach sends an AttachRequest to server, and parses the returned AttachResponse
+// Attach sends an AttachRequest to server, and parses the returned AttachResponse.
 func Attach(ctx context.Context, client internalapi.RuntimeService, opts attachOptions) error {
 	if opts.id == "" {
 		return errors.New("ID cannot be empty")

cmd/crictl/container.go

@@ -741,7 +741,7 @@ var checkpointContainerCommand = &cli.Command{
 	},
 }
 
-// RunContainer starts a container in the provided sandbox
+// RunContainer starts a container in the provided sandbox.
 func RunContainer(
 	iClient internalapi.ImageManagerService,
 	rClient internalapi.RuntimeService,
@@ -935,7 +935,7 @@ func StopContainer(client internalapi.RuntimeService, id string, timeout int64)
 	return nil
 }
 
-// CheckpointContainer sends a CheckpointContainerRequest to the server
+// CheckpointContainer sends a CheckpointContainerRequest to the server.
 func CheckpointContainer(
 	rClient internalapi.RuntimeService,
 	id string,

cmd/crictl/exec.go

@@ -147,7 +147,7 @@ func ExecSync(client internalapi.RuntimeService, opts execOptions) (int, error)
 	return 0, nil
 }
 
-// Exec sends an ExecRequest to server, and parses the returned ExecResponse
+// Exec sends an ExecRequest to server, and parses the returned ExecResponse.
 func Exec(ctx context.Context, client internalapi.RuntimeService, opts execOptions) error {
 	request := &pb.ExecRequest{
 		ContainerId: opts.id,

cmd/crictl/image.go

@@ -706,7 +706,7 @@ func ListImages(client internalapi.ImageManagerService, image string) (*pb.ListI
 	return resp, nil
 }
 
-// filterImagesList filter images based on --filter flag
+// filterImagesList filter images based on --filter flag.
 func filterImagesList(imageList []*pb.Image, filters []string) ([]*pb.Image, error) {
 	filtered := []*pb.Image{}
 	filtered = append(filtered, imageList...)

cmd/crictl/main.go

@@ -46,21 +46,21 @@ const defaultTimeout = 2 * time.Second
 const defaultTimeoutWindows = 200 * time.Second
 
 var (
-	// RuntimeEndpoint is CRI server runtime endpoint
+	// RuntimeEndpoint is CRI server runtime endpoint.
 	RuntimeEndpoint string
-	// RuntimeEndpointIsSet is true when RuntimeEndpoint is configured
+	// RuntimeEndpointIsSet is true when RuntimeEndpoint is configured.
 	RuntimeEndpointIsSet bool
-	// ImageEndpoint is CRI server image endpoint, default same as runtime endpoint
+	// ImageEndpoint is CRI server image endpoint, default same as runtime endpoint.
 	ImageEndpoint string
-	// ImageEndpointIsSet is true when ImageEndpoint is configured
+	// ImageEndpointIsSet is true when ImageEndpoint is configured.
 	ImageEndpointIsSet bool
-	// Timeout  of connecting to server (default: 2s on Linux, 200s on Windows)
+	// Timeout  of connecting to server (default: 2s on Linux, 200s on Windows).
 	Timeout time.Duration
-	// Debug enable debug output
+	// Debug enable debug output.
 	Debug bool
-	// PullImageOnCreate enables pulling image on create requests
+	// PullImageOnCreate enables pulling image on create requests.
 	PullImageOnCreate bool
-	// DisablePullOnRun disable pulling image on run requests
+	// DisablePullOnRun disable pulling image on run requests.
 	DisablePullOnRun bool
 	// tracerProvider is the global OpenTelemetry tracing instance.
 	tracerProvider *sdktrace.TracerProvider

cmd/crictl/portforward.go

@@ -68,7 +68,7 @@ var runtimePortForwardCommand = &cli.Command{
 	},
 }
 
-// PortForward sends an PortForwardRequest to server, and parses the returned PortForwardResponse
+// PortForward sends an PortForwardRequest to server, and parses the returned PortForwardResponse.
 func PortForward(client internalapi.RuntimeService, opts portforwardOptions) error {
 	if opts.id == "" {
 		return errors.New("ID cannot be empty")

cmd/crictl/runtime_config.go

@@ -43,7 +43,7 @@ var runtimeConfigCommand = &cli.Command{
 	},
 }
 
-// Attach sends an AttachRequest to server, and parses the returned AttachResponse
+// Attach sends an AttachRequest to server, and parses the returned AttachResponse.
 func runtimeConfig(client internalapi.RuntimeService) error {
 	resp, err := InterruptableRPC(nil, func(ctx context.Context) (*pb.RuntimeConfigResponse, error) {
 		return client.RuntimeConfig(ctx)

cmd/crictl/util.go

@@ -42,15 +42,15 @@ import (
 )
 
 const (
-	// truncatedImageIDLen is the truncated length of imageID
+	// truncatedImageIDLen is the truncated length of imageID.
 	truncatedIDLen = 13
 )
 
 var (
 	// The global stopCh for monitoring Interrupt signal.
 	// DO NOT use it directly. Use SetupInterruptSignalHandler() to get it.
 	signalIntStopCh chan struct{}
-	// only setup stopCh once
+	// only setup stopCh once.
 	signalIntSetupOnce = &sync.Once{}
 )
 

cmd/critest/cri_test.go

@@ -57,7 +57,7 @@ func init() {
 }
 
 // Load server configuration from file and use each config settings if that
-// option is not set in the CLI
+// option is not set in the CLI.
 func getConfigFromFile() {
 	var configFromFile *common.ServerConfiguration
 

pkg/benchmark/image.go

@@ -35,7 +35,7 @@ import (
 const (
 	defaultImageBenchmarkTimeoutSeconds = 10
 
-	// defaultImageListingPrefix is for avoiding Docker Hub's rate limit
+	// defaultImageListingPrefix is for avoiding Docker Hub's rate limit.
 	defaultImageListingPrefix = "public.ecr.aws/docker/library/"
 )
 

pkg/benchmark/util.go

@@ -29,7 +29,7 @@ import (
 // LifecycleBenchmarkDatapoint encodes a single benchmark for a lifecycle operation.
 // Contains a slice of int64s which represent the duration in nanoseconds of the
 // operations which comprise a lifecycle being benchmarked.
-// (e.g. the individual CRUD operations which are cycled through during the benchmark)
+// (e.g. the individual CRUD operations which are cycled through during the benchmark).
 type LifecycleBenchmarkDatapoint struct {
 	// int64 index of the sample.
 	SampleIndex int `json:"sampleIndex"`

pkg/common/config.go

@@ -24,7 +24,7 @@ import (
 	"time"
 )
 
-// ServerConfiguration is the config for connecting to and using a CRI server
+// ServerConfiguration is the config for connecting to and using a CRI server.
 type ServerConfiguration struct {
 	// RuntimeEndpoint is CRI server runtime endpoint
 	RuntimeEndpoint string
@@ -40,7 +40,7 @@ type ServerConfiguration struct {
 	DisablePullOnRun bool
 }
 
-// GetServerConfigFromFile returns the CRI server configuration from file
+// GetServerConfigFromFile returns the CRI server configuration from file.
 func GetServerConfigFromFile(configFileName, currentDir string) (*ServerConfiguration, error) {
 	serverConfig := ServerConfiguration{}
 	if _, err := os.Stat(configFileName); err != nil {

pkg/common/file.go

@@ -26,7 +26,7 @@ import (
 )
 
 // Config is the internal representation of the yaml that defines
-// server configuration
+// server configuration.
 type Config struct {
 	RuntimeEndpoint   string
 	ImageEndpoint     string
@@ -77,7 +77,7 @@ func WriteConfig(c *Config, filepath string) error {
 	return os.WriteFile(filepath, data, 0o644)
 }
 
-// Extracts config options from the yaml data which is loaded from file
+// Extracts config options from the yaml data which is loaded from file.
 func getConfigOptions(yamlData yaml.Node) (*Config, error) {
 	config := Config{}
 	config.yamlData = &yamlData
@@ -131,7 +131,7 @@ func getConfigOptions(yamlData yaml.Node) (*Config, error) {
 	return &config, nil
 }
 
-// Set config options on yaml data for persistece to file
+// Set config options on yaml data for persistece to file.
 func setConfigOptions(config *Config) {
 	setConfigOption("runtime-endpoint", config.RuntimeEndpoint, config.yamlData)
 	setConfigOption("image-endpoint", config.ImageEndpoint, config.yamlData)
@@ -141,7 +141,7 @@ func setConfigOptions(config *Config) {
 	setConfigOption("disable-pull-on-run", strconv.FormatBool(config.DisablePullOnRun), config.yamlData)
 }
 
-// Set config option on yaml
+// Set config option on yaml.
 func setConfigOption(configName, configValue string, yamlData *yaml.Node) {
 	if yamlData.Content == nil || len(yamlData.Content) == 0 {
 		yamlData.Kind = yaml.DocumentNode

pkg/framework/framework.go

@@ -53,7 +53,7 @@ func NewCRIFramework(client *InternalAPIClient) *Framework {
 	return f
 }
 
-// BeforeEach gets a client
+// BeforeEach gets a client.
 func (f *Framework) BeforeEach() {
 	if f.CRIClient == nil {
 		c, err := LoadCRIClient()
@@ -62,7 +62,7 @@ func (f *Framework) BeforeEach() {
 	}
 }
 
-// AfterEach clean resources
+// AfterEach clean resources.
 func (f *Framework) AfterEach() {
 	f.CRIClient = nil
 }

pkg/framework/util.go

@@ -37,63 +37,63 @@ import (
 )
 
 var (
-	// the callbacks to run during BeforeSuite
+	// the callbacks to run during BeforeSuite.
 	beforeSuiteCallbacks []func()
 
-	// DefaultPodLabels are labels used by default in pods
+	// DefaultPodLabels are labels used by default in pods.
 	DefaultPodLabels map[string]string
 
-	// DefaultContainerCommand is the default command used for containers
+	// DefaultContainerCommand is the default command used for containers.
 	DefaultContainerCommand []string
 
-	// DefaultPauseCommand is the default command used for containers
+	// DefaultPauseCommand is the default command used for containers.
 	DefaultPauseCommand []string
 
-	// DefaultLinuxPodLabels default pod labels for Linux
+	// DefaultLinuxPodLabels default pod labels for Linux.
 	DefaultLinuxPodLabels = map[string]string{}
 
-	// DefaultLinuxContainerCommand default container command for Linux
+	// DefaultLinuxContainerCommand default container command for Linux.
 	DefaultLinuxContainerCommand = []string{"top"}
 
-	// DefaultLinuxPauseCommand default container command for Linux pause
+	// DefaultLinuxPauseCommand default container command for Linux pause.
 	DefaultLinuxPauseCommand = []string{"sh", "-c", "top"}
 
-	// DefaultLcowPodLabels default pod labels for Linux containers on Windows
+	// DefaultLcowPodLabels default pod labels for Linux containers on Windows.
 	DefaultLcowPodLabels = map[string]string{
 		"sandbox-platform": "linux/amd64",
 	}
 
-	// DefaultWindowsPodLabels default pod labels for Windows
+	// DefaultWindowsPodLabels default pod labels for Windows.
 	DefaultWindowsPodLabels = map[string]string{}
 
-	// DefaultWindowsContainerCommand default container command for Windows
+	// DefaultWindowsContainerCommand default container command for Windows.
 	DefaultWindowsContainerCommand = []string{"cmd", "/c", "ping -t localhost"}
 
-	// DefaultWindowsPauseCommand default container pause command for Windows
+	// DefaultWindowsPauseCommand default container pause command for Windows.
 	DefaultWindowsPauseCommand = []string{"powershell", "-c", "ping -t localhost"}
 )
 
 const (
-	// DefaultUIDPrefix is a default UID prefix of PodSandbox
+	// DefaultUIDPrefix is a default UID prefix of PodSandbox.
 	DefaultUIDPrefix string = "cri-test-uid"
 
-	// DefaultNamespacePrefix is a default namespace prefix of PodSandbox
+	// DefaultNamespacePrefix is a default namespace prefix of PodSandbox.
 	DefaultNamespacePrefix string = "cri-test-namespace"
 
-	// DefaultAttempt is a default attempt prefix of PodSandbox or container
+	// DefaultAttempt is a default attempt prefix of PodSandbox or container.
 	DefaultAttempt uint32 = 2
 
-	// DefaultStopContainerTimeout is the default timeout for stopping container
+	// DefaultStopContainerTimeout is the default timeout for stopping container.
 	DefaultStopContainerTimeout int64 = 60
 
-	// DefaultLinuxContainerImage default container image for Linux
+	// DefaultLinuxContainerImage default container image for Linux.
 	DefaultLinuxContainerImage string = DefaultRegistryE2ETestImagesPrefix + "busybox:1.29-2"
 
-	// DefaultWindowsContainerImage default container image for Windows
+	// DefaultWindowsContainerImage default container image for Windows.
 	DefaultWindowsContainerImage string = DefaultLinuxContainerImage
 )
 
-// Set the constants based on operating system and flags
+// Set the constants based on operating system and flags.
 var _ = BeforeSuite(func() {
 	if runtime.GOOS != "windows" || TestContext.IsLcow {
 		DefaultPodLabels = DefaultLinuxPodLabels
@@ -122,7 +122,7 @@ var _ = BeforeSuite(func() {
 	}
 })
 
-// AddBeforeSuiteCallback adds a callback to run during BeforeSuite
+// AddBeforeSuiteCallback adds a callback to run during BeforeSuite.
 func AddBeforeSuiteCallback(callback func()) bool {
 	beforeSuiteCallbacks = append(beforeSuiteCallbacks, callback)
 	return true
@@ -258,7 +258,7 @@ func CreateDefaultContainer(rc internalapi.RuntimeService, ic internalapi.ImageM
 	return CreateDefaultContainerWithLabels(rc, ic, podID, podConfig, prefix, nil)
 }
 
-// CreateDefaultContainerWithLabels creates a default container with default options
+// CreateDefaultContainerWithLabels creates a default container with default options.
 func CreateDefaultContainerWithLabels(rc internalapi.RuntimeService, ic internalapi.ImageManagerService, podID string, podConfig *runtimeapi.PodSandboxConfig, prefix string, labels map[string]string) string {
 	containerName := prefix + NewUUID()
 	containerConfig := &runtimeapi.ContainerConfig{
@@ -285,7 +285,7 @@ func CreatePauseContainer(rc internalapi.RuntimeService, ic internalapi.ImageMan
 	return CreateContainer(rc, ic, containerConfig, podID, podConfig)
 }
 
-// CreateContainerWithError creates a container but leave error check to caller
+// CreateContainerWithError creates a container but leave error check to caller.
 func CreateContainerWithError(rc internalapi.RuntimeService, ic internalapi.ImageManagerService, config *runtimeapi.ContainerConfig, podID string, podConfig *runtimeapi.PodSandboxConfig) (string, error) {
 	// Pull the image if it does not exist.
 	imageName := config.Image.Image