Improvements on a unit-testing approach

[ameteiko]

Software Package Metrics

Metrics:

• Files. The number of files inside a package.
• Afferent. The number of other packages that depend upon object within the package is an indicator of the package's responsibility.
• Efferent. The number of other packages that the objects in a package depend upon is an indicator of the package's dependence on externalities.
• Abstractions. The tally for structs and interfaces definitions.
• Implementations. Counts functions and methods inside a package.
• Instability. The ratio of efferent coupling to total coupling (efferent + afferent). This metric is an indicator of the package's resilience to change (with 0 indicating a completely stable package and 1 indicating a completely unstable package).
• Abstractness. The ratio of abstractions to the number of implementations in the analysed package (with 0 indicating a completely concrete package and 1 indicating a completely abstract package).
• Distance. Distance from the main sequence

Path	Files	External	Afferent	Efferent	Abstractions	Implementations	Instability	Abstractness	Coverage	Distance
cmd	2	21	0	12	1	13	1	0.07		0.07
internal	3	9	3	1	1	5	0.25	0.17	64.3	0.58
internal/controller	5	24	1	21	4	59	0.95	0.06		0.01
internal/declarative/v2	20	25	2	4	39	133	0.67	0.23	8.2	0.02
internal/declarative/v2/mock	1	5	0	1	18	70	1	0.2		0.2
internal/manifest	7	19	1	7	6	24	0.88	0.2	2.5	0.09
internal/pkg/metrics	4	4	4	2	3	17	0.33	0.15		0.85
pkg/adapter	1	1	2	0	0	2	0	0		1
pkg/cache	1	1	1	0	0	2	0	0		1
pkg/channel	1	4	5	4	3	11	0.44	0.21		0.12
pkg/common	1	0	3	0	0	0	0	0		1
pkg/img	2	10	1	4	3	7	0.80	0.3		0.3
pkg/istio	1	8	1	1	1	15	0.50	0.06		0.94
pkg/log	2	5	6	0	0	1	0	0		1
pkg/matcher	1	1	2	0	0	4	0	0	6.8	1
pkg/module/common	1	2	3	3	1	5	0.50	0.17		0.58
pkg/module/parse	1	2	1	7	2	7	0.88	0.22		0.07
pkg/module/sync	2	7	1	7	2	16	0.88	0.11	3.7	0.18
pkg/ocmextensions	1	5	2	0	0	4	0	0		1
pkg/queue	1	0	2	1	1	1	0.33	0.5		0.5
pkg/remote	8	15	6	5	12	46	0.45	0.21	1.7	0.19
pkg/security	1	4	1	2	2	8	0.67	0.2	2.1	0.47
pkg/signature	1	9	3	1	3	7	0.25	0.3		0.7
pkg/status	2	2	1	2	2	4	0.67	0.33	5.7	0.67
pkg/testutils	10	19	0	8	0	77	1	0		0
pkg/testutils/builder	4	9	1	2	4	33	0.67	0.11		0.89
pkg/types	1	1	2	0	1	1	0	0.5		0.5
pkg/util	1	4	7	0	0	2	0	0		1
pkg/watch	3	15	1	2	3	12	0.67	0.2		0.8
pkg/watcher	7	19	3	6	11	38	0.67	0.22		0.02

---

Files modifications

📄.dockerignore                                                                 1     
📄.gitignore                                                                   14     
📄.golangci.yaml                                                               21     
📄.mlc.config.json                                                              1     
📄CODEOWNERS                                                                    3     
📄Dockerfile                                                                   11     
📄LICENCE                                                                       1     
📄Makefile                                                                     26     
📄PROJECT                                                                       8     
📄README.md                                                                    26     
📄go.mod                                                                      118     
📄go.sum                                                                      115     
📄sec-scanners-config.yaml                                                      1     
📁LICENSES
  📄Apache-2.0.txt                                                              1     
📁api
  📄README.md                                                                   4     
  📄go.mod                                                                      3     
  📄go.sum                                                                      3     
  📄scheme.go                                                                   9     
  📁api/shared
    📄cr_finalizer.go                                                           1     
    📄cr_kind.go                                                                1     100.0
    📄external_annotations.go                                                   1     
    📄external_labels.go                                                        1     
    📄last_operation.go                                                         2     
    📄operator_annotations.go                                                   1     
    📄operator_labels.go                                                        2     
    📄resource.go                                                               2     16.7
    📄state.go                                                                  1     50.0
    📄status.go                                                                 2     
    📄zz_generated.deepcopy.go                                                  1     
  📁api/v1beta1
    📄groupversion_info.go                                                      6     
    📄kyma_conversion.go                                                       10     
    📄kyma_types.go                                                            12     
    📄manifest_conversion.go                                                    6     
    📄manifest_types.go                                                         9     
    📄moduletemplate_conversion.go                                              8     
    📄moduletemplate_types.go                                                  12     
    📄watcher_conversion.go                                                     5     
    📄watcher_types.go                                                          8     
    📄zz_generated.deepcopy.go                                                 11     
  📁api/v1beta2
    📄condition_messages.go                                                     3     68.4
    📄error.go                                                                  1     
    📄groupversion_info.go                                                      3     
    📄kyma_conversion.go                                                        1     
    📄kyma_types.go                                                            15     28.1
    📄kyma_webhook.go                                                           4     
    📄manifest_conversion.go                                                    1     
    📄manifest_types.go                                                        11     25.0
    📄manifest_webhook.go                                                       2     
    📄moduletemplate_conversion.go                                              1     
    📄moduletemplate_types.go                                                  21     1.9
    📄moduletemplate_webhook.go                                                 9     
    📄watcher_conversion.go                                                     1     
    📄watcher_types.go                                                          8     8.3
    📄watcher_webhook.go                                                        2     
    📄zz_generated.deepcopy.go                                                 12     
📁cmd
  📄flags.go                                                                   11     
  📄main.go                                                                    16     
📁config
  📁config/certmanager
    📄certificate.yaml                                                          1     
    📄kustomization.yaml                                                        1     
    📄kustomizeconfig.yaml                                                      1     
  📁config/control-plane
    📄kustomization.yaml                                                       35     
    📁config/control-plane/patches
      📄adjust_resources_in_deployment.yaml                                     3     
      📄namespace_delete.yaml                                                   1     
      📄secured_manager_auth_proxy.yaml                                         1     
      📄service_monitor.yaml                                                    1     
      📄unique_certificate_name.yaml                                            1     
      📄unique_manager_webhook_patch.yaml                                       1     
      📄webhook_configuration_cainjection.yaml                                  2     
  📁config/crd
    📄kustomization.yaml                                                        6     
    📄kustomizeconfig.yaml                                                      1     
    📁config/crd/bases
      📄operator.kyma-project.io_kcpmodules.yaml                                7     
      📄operator.kyma-project.io_kymas.yaml                                    20     
      📄operator.kyma-project.io_manifests.yaml                                13     
      📄operator.kyma-project.io_moduletemplates.yaml                          17     
      📄operator.kyma-project.io_watchers.yaml                                 17     
      📄test.declarative.kyma-project.io_testapis.yaml                          7     
    📁config/crd/patches
      📄cainjection_in_kymas.yaml                                               1     
      📄cainjection_in_manifests.yaml                                           1     
      📄cainjection_in_moduletemplates.yaml                                     1     
      📄cainjection_in_watchers.yaml                                            1     
      📄webhook_in_kymas.yaml                                                   1     
      📄webhook_in_manifests.yaml                                               1     
      📄webhook_in_moduletemplates.yaml                                         1     
      📄webhook_in_watchers.yaml                                                1     
  📁config/default
    📄kustomization.yaml                                                       14     
    📄manager_config_patch.yaml                                                 1     
    📄manager_webhook_patch.yaml                                                1     
    📄webhookcainjection_patch.yaml                                             3     
  📁config/grafana
    📄kustomization.yaml                                                        3     
    📄overview.json                                                            11     
    📄status.json                                                               2     
  📁config/istio
    📄ap.yaml                                                                   3     
    📄commonlabels_override.yaml                                                1     
    📄kustomization.yaml                                                        3     
    📁config/istio/patches
      📄exclude_webhook_port.yaml                                               1     
      📄istio_namespace_labels.yaml                                             1     
  📁config/load_test
    📄kustomization.yaml                                                        8     
    📄manager_webhook_patch.yaml                                                1     
    📄metrics_cluster_role_binding.yaml                                         1     
    📄metrics_role.yaml                                                         1     
    📄metrics_role_binding.yaml                                                 1     
    📄webhookcainjection_patch.yaml                                             1     
    📁config/load_test/patches
      📄adjust_resources_in_deployment.yaml                                     2     
  📁config/manager
    📄controller_manager_config.yaml                                            1     
    📄kustomization.yaml                                                        2     
    📄manager.yaml                                                              3     
    📄metrics_service.yaml                                                      1     
  📁config/prometheus
    📄commonlabels_override.yaml                                                1     
    📄kustomization.yaml                                                        1     
    📄monitor.yaml                                                              1     
  📁config/rbac
    📄kustomization.yaml                                                        1     
    📄kyma_editor_role.yaml                                                     1     
    📄kyma_viewer_role.yaml                                                     1     
    📄leader_election_role.yaml                                                 1     
    📄leader_election_role_binding.yaml                                         1     
    📄manifest_editor_role.yaml                                                 1     
    📄manifest_role.yaml                                                        2     
    📄manifest_viewer_role.yaml                                                 1     
    📄metrics_clusterrole.yaml                                                  1     
    📄metrics_clusterrole_binding.yaml                                          2     
    📄moduletemplate_editor_role.yaml                                           1     
    📄moduletemplate_viewer_role.yaml                                           1     
    📄role.yaml                                                                 5     
    📄role_binding.yaml                                                         1     
    📄service_account.yaml                                                      1     
    📄watcher_editor_role.yaml                                                  1     
    📄watcher_viewer_role.yaml                                                  1     
  📁config/samples
    📄.gitignore                                                                1     
    📁config/samples/component-integration-installed
      📄operator_v1beta1_kyma.yaml                                              3     
      📄operator_v1beta2_kyma.yaml                                              2     
      📄operator_v1beta2_moduletemplate_kcp-module-cred-label.yaml              3     
      📄operator_v1beta2_moduletemplate_kcp-module.yaml                         3     
      📄operator_v1beta2_moduletemplate_ocm.software.v3alpha1.yaml              1     
      📄v1_secret_remote_cluster_access.yaml                                    2     
      📁config/samples/component-integration-installed/crd
        📄operator.kyma-project.io_kcpmodules.yaml                              6     
        📁config/samples/component-integration-installed/crd/v1beta1
          📄kcpmodule_types.go                                                  4     
        📁config/samples/component-integration-installed/crd/v1beta2
          📄kcpmodule_types.go                                                  3     
    📁config/samples/tests
      📄istio-test-resources.yaml                                               4     
      📁config/samples/tests/crds
        📄cert-manager-v1.10.1.crds.yaml                                        1     
        📄istio-v1.17.1.crds.yaml                                               1     
        📄operator.kyma-project.io_v1beta2_samplecrd-invalid.yaml               1     
        📄operator.kyma-project.io_v1beta2_samplecrd.yaml                       1     
  📁config/watcher
    📄certificate_setup.yaml                                                    4     
    📄gateway.yaml                                                              5     
    📄kustomization.yaml                                                       13     
    📄operator_v1beta2_watcher.yaml                                             5     
  📁config/watcher_local_test
    📄kustomization.yaml                                                       18     
    📁config/watcher_local_test/patches
      📄adjust_resources_for_local_setup.yaml                                   1     
      📄namespace_create.yaml                                                   1     
      📄servicemonitor_delete.yaml                                              1     
  📁config/webhook
    📄kustomization.yaml                                                        4     
    📄kustomizeconfig.yaml                                                      1     
    📄manifests.yaml                                                            7     
    📄service.yaml                                                              1     
📁docs
  📄README.md                                                                   7     
  📄modularization.md                                                           3     
  📁docs/assets
    📄kyma-module-template-structure.svg                                        2     
    📄kyma-operator-architecture.svg                                            6     
    📄lifecycle-manager-architecture.svg                                        1     
  📁docs/developer-tutorials
    📄README.md                                                                 1     
    📄config-private-registry.md                                                6     
    📄local-test-setup.md                                                       7     
    📄prepare-gcr-registry.md                                                   4     
    📄provision-cluster-and-registry.md                                         3     
    📄starting-operator-with-webhooks.md                                        3     
  📁docs/technical-reference
    📄architecture.md                                                           6     
    📄controllers.md                                                            3     
    📄running-modes.md                                                          5     
    📁docs/technical-reference/api
      📄README.md                                                               6     
      📄changelog.md                                                            1     
      📄kyma-cr.md                                                              8     
      📄manifest-cr.md                                                          6     
      📄moduleTemplate-cr.md                                                    6     
  📁docs/user-tutorials
    📄01-10-control-plane-quick-start.md                                        3     
    📄02-10-manage-module-with-custom-resource-policy.md                        2     
📁hack
  📄boilerplate.go.txt                                                          1     
  📄k3d-secret-gen.sh                                                           1     
  📁hack/code-gen
    📄gen.sh                                                                    1     
📁internal
  📄rate_limiter.go                                                             1     
  📄resources.go                                                                2     
  📄util.go                                                                    11     69.2
  📁internal/controller
    📄README.md                                                                 1     
    📄kyma_controller.go                                                       13     
    📄manifest_controller.go                                                    5     
    📄purge_controller.go                                                       7     
    📄setup.go                                                                  3     
    📄watcher_controller.go                                                     6     
  📁internal/declarative
    📄README.md                                                                 3     
    📁internal/declarative/v2
      📄cleanup.go                                                              8     
      📄client.go                                                               2     
      📄client_cache.go                                                         2     
      📄client_proxy.go                                                         4     
      📄cluster_info.go                                                         1     
      📄default_transforms.go                                                   3     66.7
      📄factory.go                                                              7     
      📄inmemory_rendered.go                                                    6     
      📄kube_factory_proxy.go                                                   6     
      📄moduleCR_deletion_check.go                                              2     
      📄object.go                                                               8     
      📄options.go                                                              9     
      📄ready_check.go                                                          9     
      📄reconciler.go                                                          29     6.4
      📄resource.go                                                             1     
      📄resource_converter.go                                                   5     
      📄rest_getter_proxy.go                                                    2     
      📄spec.go                                                                 6     
      📄ssa.go                                                                  9     83.9
      📄util.go                                                                 4     
      📁internal/declarative/v2/mock
        📄object.go                                                             3     
  📁internal/manifest
    📄README.md                                                                 2     
    📄client.go                                                                 5     
    📄cr_deletion_check.go                                                      3     
    📄custom_resource.go                                                        6     
    📄parse.go                                                                  6     
    📄ready_check.go                                                           12     61.8
    📄skr_client_lookup.go                                                      5     
    📄spec_resolver.go                                                          6     
  📁internal/pkg
    📁internal/pkg/metrics
      📄common.go                                                               6     
      📄kyma.go                                                                 1     
      📄purge.go                                                                2     
      📄watcher.go                                                              1     
  📁internal/tests
    📁internal/tests/api
📁pkg
  📁pkg/adapter
    📄eventing_adapter.go                                                       2     
  📁pkg/cache
    📄crd_cache.go                                                              4     
  📁pkg/channel
    📄lookup.go                                                                21     
  📁pkg/common
    📄error.go                                                                  1     
  📁pkg/img
    📄layer.go                                                                  8     
    📄parse.go                                                                 18     
  📁pkg/istio
    📄client.go                                                                18     
  📁pkg/log
    📄levels.go                                                                 1     
    📄logger.go                                                                 3     
  📁pkg/matcher
    📄matcher.go                                                                2     83.9
  📁pkg/module
    📁pkg/module/common
      📄module.go                                                              13     
    📁pkg/module/parse
      📄template_to_module.go                                                  32     
    📁pkg/module/sync
      📄errors.go                                                               2     
      📄runner.go                                                               9     21.3
  📁pkg/ocmextensions
    📄cred.go                                                                   4     
  📁pkg/queue
    📄requeue_intervals.go                                                      4     
  📁pkg/remote
    📄client.go                                                                 2     
    📄client_cache.go                                                           4     
    📄client_lookup.go                                                          8     
    📄cluster_client.go                                                         8     
    📄context.go                                                                9     
    📄crd_upgrade.go                                                           13     7.5
    📄kyma_synchronization_context.go                                          30     3.0
    📄remote_catalog.go                                                        15     
  📁pkg/security
    📄san_pinning.go                                                            9     12.9
  📁pkg/signature
    📄verifier.go                                                              11     
  📁pkg/status
    📄conditions.go                                                             8     100.0
    📄kyma_helper.go                                                           17     
  📁pkg/test_samples
    📄auth_secret.yaml                                                          1     
    📄empty-file.yaml                                                           1     
    📄raw-manifest.yaml                                                         3     
    📁pkg/test_samples/oci
      📄btp-operator-manifest.yaml                                              1     
      📄invalid-yaml.yaml                                                       1     
      📄manifest-contains-duplicate-resources.yaml                              1     
      📄rendered.yaml                                                           4     
      📄template-operator-manifest.yaml                                         1     
      📄valid-yaml.yaml                                                         1     
  📁pkg/testutils
    📄deployment.go                                                             5     
    📄klm.go                                                                    1     
    📄kyma.go                                                                  12     1.7
    📄manifest.go                                                              11     1.3
    📄metrics.go                                                                1     
    📄modulecr.go                                                               9     
    📄moduletemplate.go                                                         4     
    📄unstructured.go                                                           1     
    📄utils.go                                                                 42     
    📄watcher.go                                                                1     
    📁pkg/testutils/builder
      📄crds.go                                                                 4     92.3
      📄kyma.go                                                                 5     92.3
      📄modulecr.go                                                             2     73.3
      📄moduletemplate.go                                                       4     
  📁pkg/types
    📄label_error.go                                                            1     
  📁pkg/util
    📄error.go                                                                  3     42.1
  📁pkg/watch
    📄change_handler_client.go                                                  1     
    📄restricted_enqueue_request_for_owner.go                                   7     
    📄template_change.go                                                        9     
  📁pkg/watcher
    📄ca_certificate_cache.go                                                   1     
    📄certificate_manager.go                                                    4     
    📄gateway.go                                                                1     
    📄skr_webhook_manager.go                                                    3     
    📄skr_webhook_manifest_manager.go                                          25     
    📄skr_webhook_resources.go                                                 14     
    📄webhook_chart.go                                                         18     
📁skr-webhook
  📄resources.yaml                                                              9     
📁tests
  📁tests/e2e
    📄Makefile                                                                  2     
    📄README.md                                                                 1     
  📁tests/integration
    📄paths.go                                                                  1     
    📁tests/integration/apiwebhook
    📁tests/integration/controller
      📁tests/integration/controller/controlplane
      📁tests/integration/controller/eventfilters
      📁tests/integration/controller/kyma
      📁tests/integration/controller/manifest
        📄manifest.go                                                           3     
        📁tests/integration/controller/manifest/custom_resource_check
      📁tests/integration/controller/purge
      📁tests/integration/controller/withwatcher
    📁tests/integration/declarative
      📄api.go                                                                  2     
      📄zz_generated.deepcopy.go                                                1     
    📁tests/integration/security
    📁tests/integration/watcher
  📁tests/moduletemplates
    📄moduletemplate_template_operator_v1_regular.yaml                          1     
    📄moduletemplate_template_operator_v2_fast.yaml                             1     
    📄moduletemplate_template_operator_v2_regular_new_version.yaml              1 

Packages changes heatmap

A fragment of the dependencies graph

[ameteiko]

Package	Comment	Ideas
pkg/adapter/eventing_adapter.go	Was changed just twice, so is a relatively stale one.	Refactor with a generic, and break the coupling with the eventing module
pkg/common/error.go	Was changed just once, so a stale one.	Merge with pkg/util/error.go and pkg/types/*