Search: mypy python check

Author: lsierant

.pre-commit-config.yaml

@@ -129,6 +129,16 @@ repos:
             ^scripts/funcs/[^/]+$
           )
 
+  - repo: local
+    hooks:
+      - id: mypy-search
+        name: mypy (search tests)
+        entry: bash -c 'cd docker/mongodb-kubernetes-tests && python -m mypy --follow-imports=silent --disable-error-code=import-untyped tests/search/ tests/common/search/'
+        language: system
+        pass_filenames: false
+        files: docker/mongodb-kubernetes-tests/tests/(common/)?search/.*\.py$
+        stages: [pre-commit]
+
   - repo: https://github.com/golangci/golangci-lint
     rev: v2.0.2
     hooks:

controllers/operator/envoy_config_builder.go

@@ -2,6 +2,15 @@ package operator
 
 import (
 	"fmt"
+	"time"
+
+	"github.com/envoyproxy/go-control-plane/pkg/wellknown"
+	"google.golang.org/protobuf/encoding/protojson"
+	"google.golang.org/protobuf/types/known/anypb"
+	"google.golang.org/protobuf/types/known/durationpb"
+	"google.golang.org/protobuf/types/known/structpb"
+	"google.golang.org/protobuf/types/known/wrapperspb"
+
 	bootstrapv3 "github.com/envoyproxy/go-control-plane/envoy/config/bootstrap/v3"
 	clusterv3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
 	corev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
@@ -13,13 +22,6 @@ import (
 	hcmv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/http_connection_manager/v3"
 	tlsv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/transport_sockets/tls/v3"
 	upstreamhttpv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/upstreams/http/v3"
-	"github.com/envoyproxy/go-control-plane/pkg/wellknown"
-	"google.golang.org/protobuf/encoding/protojson"
-	"google.golang.org/protobuf/types/known/anypb"
-	"google.golang.org/protobuf/types/known/durationpb"
-	"google.golang.org/protobuf/types/known/structpb"
-	"google.golang.org/protobuf/types/known/wrapperspb"
-	"time"
 )
 
 // ============================================================================
@@ -247,7 +249,7 @@ func buildCluster(route envoyRoute, tlsEnabled bool, caKeyName string) (*cluster
 						{
 							HostIdentifier: &endpointv3.LbEndpoint_Endpoint{
 								Endpoint: &endpointv3.Endpoint{
-									Address: socketAddress(route.UpstreamHost, uint32(route.UpstreamPort)),
+									Address: socketAddress(route.UpstreamHost, uint32(route.UpstreamPort)), //nolint:gosec
 								},
 							},
 						},

controllers/operator/envoy_config_builder_test.go

@@ -2,14 +2,16 @@ package operator
 
 import (
 	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"google.golang.org/protobuf/encoding/protojson"
+
 	bootstrapv3 "github.com/envoyproxy/go-control-plane/envoy/config/bootstrap/v3"
 	clusterv3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
 	corev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
 	tlsv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/transport_sockets/tls/v3"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-	"google.golang.org/protobuf/encoding/protojson"
-	"testing"
 )
 
 func testRoute(shardName string) envoyRoute {
@@ -306,8 +308,8 @@ func TestBuildCluster_UsesTypedExtensionProtocolOptions(t *testing.T) {
 	require.NoError(t, err)
 
 	// Verify deprecated fields are NOT set
-	assert.Nil(t, cluster.Http2ProtocolOptions, "deprecated Http2ProtocolOptions should not be set on Cluster")
-	assert.Nil(t, cluster.CommonHttpProtocolOptions, "deprecated CommonHttpProtocolOptions should not be set on Cluster")
+	assert.Nil(t, cluster.Http2ProtocolOptions, "deprecated Http2ProtocolOptions should not be set on Cluster")         //nolint:staticcheck
+	assert.Nil(t, cluster.CommonHttpProtocolOptions, "deprecated CommonHttpProtocolOptions should not be set on Cluster") //nolint:staticcheck
 
 	// Verify TypedExtensionProtocolOptions is set
 	require.Contains(t, cluster.TypedExtensionProtocolOptions, "envoy.extensions.upstreams.http.v3.HttpProtocolOptions")

controllers/operator/mongodbsearchenvoy_controller.go

@@ -7,6 +7,21 @@ import (
 	"strings"
 	"time"
 
+	"go.uber.org/zap"
+	"k8s.io/apimachinery/pkg/api/resource"
+	"k8s.io/apimachinery/pkg/util/intstr"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/controller-runtime/pkg/controller"
+	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/manager"
+	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+
+	appsv1 "k8s.io/api/apps/v1"
+	corev1 "k8s.io/api/core/v1"
+	apiErrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	ctrl "sigs.k8s.io/controller-runtime"
+
 	mdbv1 "github.com/mongodb/mongodb-kubernetes/api/v1/mdb"
 	searchv1 "github.com/mongodb/mongodb-kubernetes/api/v1/search"
 	"github.com/mongodb/mongodb-kubernetes/controllers/operator/watch"
@@ -19,19 +34,6 @@ import (
 	"github.com/mongodb/mongodb-kubernetes/pkg/kube/commoncontroller"
 	"github.com/mongodb/mongodb-kubernetes/pkg/util"
 	"github.com/mongodb/mongodb-kubernetes/pkg/util/env"
-	"go.uber.org/zap"
-	appsv1 "k8s.io/api/apps/v1"
-	corev1 "k8s.io/api/core/v1"
-	apiErrors "k8s.io/apimachinery/pkg/api/errors"
-	"k8s.io/apimachinery/pkg/api/resource"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/util/intstr"
-	ctrl "sigs.k8s.io/controller-runtime"
-	"sigs.k8s.io/controller-runtime/pkg/client"
-	"sigs.k8s.io/controller-runtime/pkg/controller"
-	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
-	"sigs.k8s.io/controller-runtime/pkg/manager"
-	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
 // TODO: in this controller, when writing code, keep in mind that we will want to re-use the "config generation" logic

controllers/operator/mongodbsearchenvoy_controller_test.go

@@ -3,9 +3,11 @@ package operator
 import (
 	"testing"
 
-	searchv1 "github.com/mongodb/mongodb-kubernetes/api/v1/search"
 	"github.com/stretchr/testify/assert"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	searchv1 "github.com/mongodb/mongodb-kubernetes/api/v1/search"
 )
 
 func TestBuildReplicaSetRoute(t *testing.T) {

controllers/searchcontroller/mongodbsearch_reconcile_helper.go

@@ -129,10 +129,10 @@ func (r *MongoDBSearchReconcileHelper) reconcile(ctx context.Context, log *zap.S
 	}
 
 	// Non-sharded (ReplicaSet) reconciliation
-	return r.reconcileNonSharded(ctx, log, version)
+	return r.reconcileNonSharded(ctx, log)
 }
 
-func (r *MongoDBSearchReconcileHelper) reconcileNonSharded(ctx context.Context, log *zap.SugaredLogger, version string) workflow.Status {
+func (r *MongoDBSearchReconcileHelper) reconcileNonSharded(ctx context.Context, log *zap.SugaredLogger) workflow.Status {
 	keyfileStsModification := statefulset.NOOP()
 	if r.mdbSearch.IsWireprotoEnabled() {
 		var err error

docker/mongodb-kubernetes-tests/tests/common/search/envoy_helpers.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from kubernetes import client
 from kubetester import create_or_update_configmap
 from kubetester.certs import create_tls_certs
@@ -325,7 +327,7 @@ def create_deployment(self):
         except Exception as e:
             logger.info(f"Envoy Deployment may already exist: {e}")
 
-    def _create_service(self, svc_name: str, extra_labels: dict = None):
+    def _create_service(self, svc_name: str, extra_labels: Optional[dict] = None):
         svc_labels = {"app": self.name}
         if extra_labels:
             svc_labels.update(extra_labels)

docker/mongodb-kubernetes-tests/tests/common/search/movies_search_helper.py

@@ -24,7 +24,7 @@ class SampleMoviesSearchHelper:
     archive_url: str
     tools_pod: Optional[ToolsPod]
 
-    def __init__(self, search_tester: SearchTester, tools_pod: ToolsPod = None):
+    def __init__(self, search_tester: SearchTester, tools_pod: Optional[ToolsPod] = None):
         self.search_tester = search_tester
         self.tools_pod = tools_pod
         self.db_name = "sample_mflix"

docker/mongodb-kubernetes-tests/tests/common/search/search_deployment_helper.py

@@ -266,39 +266,6 @@ def create_replicaset_mdb(
 
         return resource
 
-    def mdbs_for_ext_rs_source(
-        self,
-        mongot_user_name: str,
-        rs_members: int = 3,
-    ) -> MongoDBSearch:
-        resource = MongoDBSearch.from_yaml(
-            yaml_fixture("search-minimal.yaml"),
-            namespace=self.namespace,
-            name=self.mdbs_resource_name,
-        )
-
-        if try_load(resource):
-            return resource
-
-        seeds = [
-            f"{self.mdb_resource_name}-{i}.{self.mdb_resource_name}-svc.{self.namespace}.svc.cluster.local:27017"
-            for i in range(rs_members)
-        ]
-
-        resource["spec"]["source"] = {
-            "username": mongot_user_name,
-            "passwordSecretRef": {
-                "name": f"{self.mdbs_resource_name}-{mongot_user_name}-password",
-                "key": "password",
-            },
-            "external": {
-                "hostAndPorts": seeds,
-                "tls": {"ca": {"name": self.ca_configmap_name}},
-            },
-        }
-
-        return resource
-
     def install_sharded_tls_certificates(self, secret_prefix: str = "mdb-sh-"):
         mongos_service_dns = f"{self.mdb_resource_name}-svc.{self.namespace}.svc.cluster.local"
         create_sharded_cluster_certs(

docker/mongodb-kubernetes-tests/tests/search/replicaset_external_mongodb_multi_mongot_unmanaged_lb.py

@@ -110,7 +110,7 @@ def mdb(namespace: str, ca_configmap: str, issuer_ca_configmap: str, helper: Sea
 
 @fixture(scope="function")
 def mdbs(namespace: str, mdb: MongoDB, helper: SearchDeploymentHelper) -> MongoDBSearch:
-    resource = helper.mdbs_for_ext_rs_source(mongot_user_name=MONGOT_USER_NAME, rs_members=RS_MEMBERS)
+    resource = helper.mdbs_for_ext_rs_source(mongot_user_name=MONGOT_USER_NAME, members=RS_MEMBERS)
     resource["spec"]["replicas"] = 2
     resource["spec"]["lb"] = {
         "mode": "Unmanaged",
@@ -147,6 +147,7 @@ def test_install_operator(namespace: str, operator_installation_config: dict[str
 def test_create_ops_manager(namespace: str):
     """Test OpsManager deployment (skipped for Cloud Manager)."""
     ops_manager = get_ops_manager(namespace)
+    assert ops_manager is not None
     ops_manager.update()
     ops_manager.om_status().assert_reaches_phase(Phase.Running, timeout=1200)
     ops_manager.appdb_status().assert_reaches_phase(Phase.Running, timeout=600)