Adds annotations to CiliumNetworkPolicies

This MR adds annotations as part of metadata
for CiliumNetworkPolicies wrapper. With this
change policy editor can send annotations as
part of the payload when creating/updating
network policies

changelogs/unreleased/add_annotation_to_cilium_network_policies.yml

+---
+title: Adds annotations as part of metadata for CiliumNetworkPolicies wrapper
+merge_request: 50586
+author:
+type: changed

lib/gitlab/kubernetes/cilium_network_policy.rb

@@ -12,7 +12,7 @@ module Gitlab
       # We are modeling existing kubernetes resource and don't have
       # control over amount of parameters.
       # rubocop:disable Metrics/ParameterLists
-      def initialize(name:, namespace:, selector:, ingress:, resource_version: nil, description: nil, labels: nil, creation_timestamp: nil, egress: nil)
+      def initialize(name:, namespace:, selector:, ingress:, resource_version: nil, description: nil, labels: nil, creation_timestamp: nil, egress: nil, annotations: nil)
         @name = name
         @description = description
         @namespace = namespace
@@ -22,6 +22,7 @@ module Gitlab
         @resource_version = resource_version
         @ingress = ingress
         @egress = egress
+        @annotations = annotations
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -37,6 +38,7 @@ module Gitlab
           name: metadata[:name],
           description: policy[:description],
           namespace: metadata[:namespace],
+          annotations: metadata[:annotations],
           resource_version: metadata[:resourceVersion],
           labels: metadata[:labels],
           selector: spec[:endpointSelector],
@@ -57,6 +59,7 @@ module Gitlab
           name: metadata[:name],
           description: resource[:description],
           namespace: metadata[:namespace],
+          annotations: metadata[:annotations]&.to_h,
           resource_version: metadata[:resourceVersion],
           labels: metadata[:labels]&.to_h,
           creation_timestamp: metadata[:creationTimestamp],
@@ -80,7 +83,7 @@ module Gitlab
 
       private
 
-      attr_reader :name, :description, :namespace, :labels, :creation_timestamp, :resource_version, :ingress, :egress
+      attr_reader :name, :description, :namespace, :labels, :creation_timestamp, :resource_version, :ingress, :egress, :annotations
 
       def selector
         @selector ||= {}
@@ -90,6 +93,7 @@ module Gitlab
         meta = { name: name, namespace: namespace }
         meta[:labels] = labels if labels
         meta[:resourceVersion] = resource_version if resource_version
+        meta[:annotations] = annotations if annotations
         meta
       end
 

spec/lib/gitlab/kubernetes/cilium_network_policy_spec.rb

@@ -12,7 +12,8 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
       ingress: ingress,
       egress: egress,
       labels: labels,
-      resource_version: resource_version
+      resource_version: resource_version,
+      annotations: annotations
     )
   end
 
@@ -20,7 +21,7 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
     ::Kubeclient::Resource.new(
       apiVersion: Gitlab::Kubernetes::CiliumNetworkPolicy::API_VERSION,
       kind: Gitlab::Kubernetes::CiliumNetworkPolicy::KIND,
-      metadata: { name: name, namespace: namespace, resourceVersion: resource_version },
+      metadata: { name: name, namespace: namespace, resourceVersion: resource_version, annotations: annotations },
       spec: { endpointSelector: endpoint_selector, ingress: ingress, egress: egress },
       description: description
     )
@@ -34,6 +35,7 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
   let(:description) { 'example-description' }
   let(:partial_class_name) { described_class.name.split('::').last }
   let(:resource_version) { 101 }
+  let(:annotations) { { 'app.gitlab.com/alert': 'true' } }
   let(:ingress) do
     [
       {
@@ -64,6 +66,8 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
           name: example-name
           namespace: example-namespace
           resourceVersion: 101
+          annotations:
+            app.gitlab.com/alert: "true"
         spec:
           endpointSelector:
             matchLabels:
@@ -157,7 +161,7 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
         description: description,
         metadata: {
           name: name, namespace: namespace, creationTimestamp: '2020-04-14T00:08:30Z',
-          labels: { app: 'foo' }, resourceVersion: resource_version
+          labels: { app: 'foo' }, resourceVersion: resource_version, annotations: annotations
         },
         spec: { endpointSelector: endpoint_selector, ingress: ingress, egress: nil, labels: nil }
       )
@@ -168,7 +172,7 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
         apiVersion: Gitlab::Kubernetes::CiliumNetworkPolicy::API_VERSION,
         kind: Gitlab::Kubernetes::CiliumNetworkPolicy::KIND,
         description: description,
-        metadata: { name: name, namespace: namespace, resourceVersion: resource_version, labels: { app: 'foo' } },
+        metadata: { name: name, namespace: namespace, resourceVersion: resource_version, labels: { app: 'foo' }, annotations: annotations },
         spec: { endpointSelector: endpoint_selector, ingress: ingress }
       )
     end
@@ -211,7 +215,7 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
       {
         apiVersion: Gitlab::Kubernetes::CiliumNetworkPolicy::API_VERSION,
         kind: Gitlab::Kubernetes::CiliumNetworkPolicy::KIND,
-        metadata: { name: name, namespace: namespace, resourceVersion: resource_version },
+        metadata: { name: name, namespace: namespace, resourceVersion: resource_version, annotations: annotations },
         spec: { endpointSelector: endpoint_selector, ingress: ingress, egress: egress },
         description: description
       }
@@ -248,5 +252,15 @@ RSpec.describe Gitlab::Kubernetes::CiliumNetworkPolicy do
 
       it { is_expected.to eq(resource) }
     end
+
+    context 'without annotations' do
+      let(:annotations) { nil }
+
+      before do
+        resource[:metadata].delete(:annotations)
+      end
+
+      it { is_expected.to eq(resource) }
+    end
   end
 end