Fixed bug where internet object is present with empty object even whi…

…le it doesn't exist in the ClientIntents resource (#346)

.github/workflows/intents-spec.yaml

@@ -0,0 +1,5 @@
+spec:
+  calls:
+  - name: server
+  service:
+    name: client

.github/workflows/netpol-e2e-test.yaml

@@ -125,6 +125,9 @@ jobs:
           
           kubectl apply -f https://docs.otterize.com/code-examples/automate-network-policies/intents.yaml
           
+          echo "Validate intents spec format"
+          kubectl get clientintents.k8s.otterize.com -n otterize-tutorial-npol client -o yaml | awk '/spec:/,EOF' | diff -s - .github/workflows/intents-spec.yaml
+
           # should work because there is an applied intent
           echo check client log
           wait_for_log $CLI1_POD 10 "Hi, I am the server, you called, may I help you?"

src/operator/api/v1alpha3/clientintents_types.go

@@ -150,7 +150,7 @@ type Service struct {
 
 type Intent struct {
 	//+optional
-	Name string `json:"name" yaml:"name"`
+	Name string `json:"name,omitempty" yaml:"name,omitempty"`
 
 	//+optional
 	Type IntentType `json:"type,omitempty" yaml:"type,omitempty"`
@@ -168,7 +168,7 @@ type Intent struct {
 	AWSActions []string `json:"awsActions,omitempty" yaml:"awsActions,omitempty"`
 
 	//+optional
-	Internet Internet `json:"internet,omitempty" yaml:"internet,omitempty"`
+	Internet *Internet `json:"internet,omitempty" yaml:"internet,omitempty"`
 }
 
 type Internet struct {
@@ -543,7 +543,7 @@ func (in *Intent) ConvertToCloudFormat(resourceNamespace string, clientName stri
 		})
 	}
 
-	if in.Internet.Ips != nil {
+	if in.Internet != nil && len(in.Internet.Ips) != 0 {
 		intentInput.Internet = &graphqlclient.InternetConfigInput{
 			Ips: lo.ToSlicePtr(in.Internet.Ips),
 		}

src/operator/controllers/intents_reconcilers/cloud_reconciler_test.go

@@ -308,13 +308,13 @@ func (s *CloudReconcilerTestSuite) TestInternetUpload() {
 			Calls: []otterizev1alpha3.Intent{
 				{
 					Type: otterizev1alpha3.IntentTypeInternet,
-					Internet: otterizev1alpha3.Internet{
+					Internet: &otterizev1alpha3.Internet{
 						Ips: []string{"1.1.1.1", "2.2.2.0/24"},
 					},
 				},
 				{
 					Type: otterizev1alpha3.IntentTypeInternet,
-					Internet: otterizev1alpha3.Internet{
+					Internet: &otterizev1alpha3.Internet{
 						Ips:   []string{"3.3.3.3"},
 						Ports: []int{443},
 					},

src/operator/controllers/intents_reconcilers/internet_network_policy/internet_network_policy_test.go

@@ -84,7 +84,7 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) TestCreateNetworkPolicySingle
 		Calls: []otterizev1alpha3.Intent{
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips: ips,
 				},
 			},
@@ -182,14 +182,14 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) TestCreateNetworkPolicyMultip
 		Calls: []otterizev1alpha3.Intent{
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips:   []string{endpointAIp1, endpointAip2},
 					Ports: []int{endpointAPort},
 				},
 			},
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips:   []string{endpointBIp},
 					Ports: []int{endpointBPort},
 				},
@@ -306,7 +306,7 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) TestNetworkPolicyDeletedClean
 		Calls: []otterizev1alpha3.Intent{
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips: ips,
 				}},
 		},
@@ -414,7 +414,7 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) TestUpdateNetworkPolicy() {
 		Calls: []otterizev1alpha3.Intent{
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips: ips,
 				},
 			},
@@ -533,7 +533,7 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) TestRemoveOrphanNetworkPolicy
 			Calls: []otterizev1alpha3.Intent{
 				{
 					Type: otterizev1alpha3.IntentTypeInternet,
-					Internet: otterizev1alpha3.Internet{
+					Internet: &otterizev1alpha3.Internet{
 						Ips: ips,
 					},
 				},
@@ -728,7 +728,7 @@ func (s *InternetNetworkPolicyReconcilerTestSuite) testEnforcementDisabled() {
 		Calls: []otterizev1alpha3.Intent{
 			{
 				Type: otterizev1alpha3.IntentTypeInternet,
-				Internet: otterizev1alpha3.Internet{
+				Internet: &otterizev1alpha3.Internet{
 					Ips: []string{"1.1.1.1/32"},
 				},
 			},

src/operator/webhooks/clientintents_webhook_v1alpha3.go

@@ -151,6 +151,13 @@ func (v *IntentsValidatorV1alpha3) validateSpec(intents *otterizev1alpha3.Client
 			}
 		}
 		if intent.Type == otterizev1alpha3.IntentTypeInternet { // every ips should be valid ip
+			if intent.Internet == nil {
+				return &field.Error{
+					Type:   field.ErrorTypeRequired,
+					Field:  "internet",
+					Detail: fmt.Sprintf("invalid intent format. type %s must contain internet object", otterizev1alpha3.IntentTypeInternet),
+				}
+			}
 			if intent.Internet.Ips == nil || len(intent.Internet.Ips) == 0 {
 				return &field.Error{
 					Type:   field.ErrorTypeRequired,

src/operator/webhooks/webhook_suite_test.go

@@ -189,7 +189,7 @@ func (s *ValidationWebhookTestSuite) TestNameRequiredForEveryTypeExceptInternet(
 	_, err = s.AddIntentsV1alpha3("internet-intents", "internet-client", []otterizev1alpha3.Intent{
 		{
 			Type: otterizev1alpha3.IntentTypeInternet,
-			Internet: otterizev1alpha3.Internet{
+			Internet: &otterizev1alpha3.Internet{
 				Ips:   []string{"1.1.1.1"},
 				Ports: []int{80},
 			},