Merge pull request #37 from fabriziosestito/refactor/remove-easyjson

refactor: remove easyjson dependency

Author: fabriziosestito

.github/workflows/release.yml

@@ -1,17 +1,16 @@
 on:
   push:
     branches:
-    - main
+      - main
     tags:
-    - 'v*'
+      - "v*"
 
 name: Release policy
 
 jobs:
-
   test:
     name: run tests and linters
-    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-go.yml@v3.1.4
+    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-go.yml@v3.1.7
 
   release:
     needs: test
@@ -23,6 +22,6 @@ jobs:
       # Required by cosign keyless signing
       id-token: write
 
-    uses: kubewarden/github-actions/.github/workflows/reusable-release-policy-go.yml@v3.1.4
+    uses: kubewarden/github-actions/.github/workflows/reusable-release-policy-go.yml@v3.1.7
     with:
       oci-target: ghcr.io/${{ github.repository_owner }}/policies/ingress

.github/workflows/test.yml

@@ -3,4 +3,4 @@ name: Continuous integration
 jobs:
   test:
     name: run tests and linters
-    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-go.yml@v3.1.4
+    uses: kubewarden/github-actions/.github/workflows/reusable-test-policy-go.yml@v3.1.7

Makefile

@@ -1,12 +1,12 @@
 SOURCE_FILES := $(shell find . -type f -name '*.go')
 VERSION := $(shell git describe | cut -c2-)
 
-policy.wasm: $(SOURCE_FILES) go.mod go.sum types_easyjson.go
+policy.wasm: $(SOURCE_FILES) go.mod go.sum
 	docker run \
 		--rm \
 		-e GOFLAGS="-buildvcs=false" \
 		-v ${PWD}:/src \
-		-w /src tinygo/tinygo:0.27.0 \
+		-w /src tinygo/tinygo:0.28.1 \
 		tinygo build -o policy.wasm -target=wasi -no-debug .
 
 artifacthub-pkg.yml: metadata.yml go.mod
@@ -21,14 +21,6 @@ artifacthub-pkg.yml: metadata.yml go.mod
 annotated-policy.wasm: policy.wasm metadata.yml artifacthub-pkg.yml
 	kwctl annotate -m metadata.yml -u README.md -o annotated-policy.wasm policy.wasm
 
-.PHONY: generate-easyjson
-types_easyjson.go: types.go
-	docker run \
-		--rm \
-		-v ${PWD}:/src \
-		-w /src \
-		golang:1.20-alpine ./hack/generate-easyjson.sh
-
 .PHONY: test
 test:
 	go test -v

artifacthub-pkg.yml

@@ -4,27 +4,27 @@
 #
 # This config can be saved to its default location with:
 #   kwctl scaffold artifacthub > artifacthub-pkg.yml 
-version: 0.1.15
+version: 0.1.16
 name: ingress-policy
 displayName: Ingress Policy
-createdAt: 2023-07-07T19:05:26.415988963Z
+createdAt: 2023-08-02T07:58:03.375902956Z
 description: Enforce requirements on Ingress resources
 license: Apache-2.0
 homeURL: https://github.com/kubewarden/ingress-policy
 containersImages:
 - name: policy
-  image: ghcr.io/kubewarden/policies/ingress:v0.1.15
+  image: ghcr.io/kubewarden/policies/ingress:v0.1.16
 keywords:
 - ingress
 links:
 - name: policy
-  url: https://github.com/kubewarden/ingress-policy/releases/download/v0.1.15/policy.wasm
+  url: https://github.com/kubewarden/ingress-policy/releases/download/v0.1.16/policy.wasm
 - name: source
   url: https://github.com/kubewarden/ingress-policy
 install: |
   The policy can be obtained using [`kwctl`](https://github.com/kubewarden/kwctl):
   ```console
-  kwctl pull ghcr.io/kubewarden/policies/ingress:v0.1.15
+  kwctl pull ghcr.io/kubewarden/policies/ingress:v0.1.16
   ```
 maintainers:
 - name: Kubewarden developers

go.mod

@@ -5,17 +5,15 @@ go 1.20
 require (
 	github.com/deckarep/golang-set/v2 v2.3.0
 	github.com/kubewarden/gjson v1.7.2
-	github.com/kubewarden/k8s-objects v1.24.0-kw7
-	github.com/kubewarden/policy-sdk-go v0.4.1
-	github.com/mailru/easyjson v0.7.7
+	github.com/kubewarden/k8s-objects v1.27.0-kw2
+	github.com/kubewarden/policy-sdk-go v0.5.0
 	github.com/wapc/wapc-guest-tinygo v0.3.3
 )
 
-replace github.com/go-openapi/strfmt => github.com/kubewarden/strfmt v0.1.2
+replace github.com/go-openapi/strfmt => github.com/kubewarden/strfmt v0.1.3
 
 require (
 	github.com/go-openapi/strfmt v0.21.3 // indirect
-	github.com/josharian/intern v1.0.0 // indirect
 	github.com/tidwall/match v1.0.3 // indirect
 	github.com/tidwall/pretty v1.0.2 // indirect
 )

go.sum

@@ -1,26 +1,20 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/deckarep/golang-set/v2 v2.3.0 h1:qs18EKUfHm2X9fA50Mr/M5hccg2tNnVqsiBImnyDs0g=
 github.com/deckarep/golang-set/v2 v2.3.0/go.mod h1:VAky9rY/yGXJOLEDv3OMci+7wtDpOF4IN+y82NBOac4=
-github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
-github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/kubewarden/gjson v1.7.2 h1:+cLRfPqyvjwrkgE68cGdNfUy1Z6L45DjvuFH9/ofwQ0=
 github.com/kubewarden/gjson v1.7.2/go.mod h1:jSlxpubGqBG5HHe4v8kwcc8z1JF2reJ7AJAUojw66AY=
-github.com/kubewarden/k8s-objects v1.24.0-kw4 h1:/XAEdK8uHUz+asM/PgUs1T4vgCN7d+tiDDb5azMOimo=
-github.com/kubewarden/k8s-objects v1.24.0-kw4/go.mod h1:0d8vhSnO2G4bwo58G9ncQYhsgBggGzgh+V0Wqc3CLe8=
-github.com/kubewarden/k8s-objects v1.24.0-kw7 h1:uXGSLyyp/qnipq7yNxFy5zebFRy8utoO+wn1fW6QkkU=
-github.com/kubewarden/k8s-objects v1.24.0-kw7/go.mod h1:IuIHLG1JtxjC1JnY7SyEEA9MukCh/FACcwpzaBjgdLQ=
-github.com/kubewarden/policy-sdk-go v0.3.0 h1:5WqhrC3eJP+gRti14d4vCyXCITeM95X4hob6QA96eX8=
-github.com/kubewarden/policy-sdk-go v0.3.0/go.mod h1:zJLxhZkoFVKOlHJ3mlbG8qTCvVbkZprZ7odVwVsunUo=
-github.com/kubewarden/policy-sdk-go v0.4.0 h1:qxYHarQ3fHD90QErZEjXRzErEOXLQVtTYKmtyv0rtMQ=
-github.com/kubewarden/policy-sdk-go v0.4.0/go.mod h1:pY1FrcuGdhnzzN31wNieAimI4+7rYWbtkP+tYGna0Ug=
-github.com/kubewarden/policy-sdk-go v0.4.1 h1:MTGxJaWWH6dZBwCdZ+FYVUclxveGzW3p4kuUJiZw+7M=
-github.com/kubewarden/policy-sdk-go v0.4.1/go.mod h1:pY1FrcuGdhnzzN31wNieAimI4+7rYWbtkP+tYGna0Ug=
-github.com/kubewarden/strfmt v0.1.2 h1:S0YUVkPeyUMikz8QssbMzfd1MC5K8ZqxLI2zfF8euMs=
-github.com/kubewarden/strfmt v0.1.2/go.mod h1:sqLlis8qlm4A4pnZsRyRjNxyH86fiM+7Ee7bO+uJk94=
-github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
-github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
+github.com/kubewarden/k8s-objects v1.27.0-kw2 h1:6ZA72SFtDSbCupwxlIyJimUzN0nSweMCUx5jUEnoxkw=
+github.com/kubewarden/k8s-objects v1.27.0-kw2/go.mod h1:wVx4Rg1HKml8yewPwAHUWp1wYSAtBlKV/tsmteDuK1g=
+github.com/kubewarden/policy-sdk-go v0.5.0 h1:JnSRf5pHjFzTNNp6jJbSP5a4cwzFzkUBjLujqJd+Z+w=
+github.com/kubewarden/policy-sdk-go v0.5.0/go.mod h1:1IZXauwI5iCuOZj7tU58nE/SZFb/HsCmj3ZpDVStVQs=
+github.com/kubewarden/strfmt v0.1.3 h1:bb+2rbotioROjCkziSt+hqnHXzOlumN94NxDKdV2kPI=
+github.com/kubewarden/strfmt v0.1.3/go.mod h1:DXoaaIYwqW1LyyRoMeyxfHUU+VUSTNFdj38juCXfRzs=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/tidwall/match v1.0.3 h1:FQUVvBImDutD8wJLN6c5eMzWtjgONK9MwIBCOrUJKeE=
 github.com/tidwall/match v1.0.3/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
 github.com/tidwall/pretty v1.0.2 h1:Z7S3cePv9Jwm1KwS0513MRaoUe3S01WPbLNV40pwWZU=
 github.com/tidwall/pretty v1.0.2/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk=
 github.com/wapc/wapc-guest-tinygo v0.3.3 h1:jLebiwjVSHLGnS+BRabQ6+XOV7oihVWAc05Hf1SbeR0=
 github.com/wapc/wapc-guest-tinygo v0.3.3/go.mod h1:mzM3CnsdSYktfPkaBdZ8v88ZlfUDEy5Jh5XBOV3fYcw=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

hack/generate-easyjson.sh

@@ -1,37 +1,27 @@
 package main
 
 import (
+	"encoding/json"
+
 	mapset "github.com/deckarep/golang-set/v2"
 	kubewarden "github.com/kubewarden/policy-sdk-go"
 	kubewarden_protocol "github.com/kubewarden/policy-sdk-go/protocol"
-	easyjson "github.com/mailru/easyjson"
 )
 
 type Settings struct {
-	RequireTls bool       `json:"requireTLS"`
+	RequireTls bool               `json:"requireTLS"`
 	AllowPorts mapset.Set[uint64] `json:"allowPorts"`
 	DenyPorts  mapset.Set[uint64] `json:"denyPorts"`
 }
 
-func NewSettingsFromRaw(rawSettings *RawSettings) Settings {
-	allowPorts := mapset.NewThreadUnsafeSet[uint64](rawSettings.AllowPorts...)
-	denyPorts := mapset.NewThreadUnsafeSet[uint64](rawSettings.DenyPorts...)
-
-	return Settings{
-		RequireTls: rawSettings.RequireTls,
-		AllowPorts: allowPorts,
-		DenyPorts:  denyPorts,
-	}
-}
-
 func NewSettingsFromValidationReq(validationReq *kubewarden_protocol.ValidationRequest) (Settings, error) {
-	rawSettings := RawSettings{}
-	err := easyjson.Unmarshal(validationReq.Settings, &rawSettings)
+	settings := Settings{}
+	err := json.Unmarshal(validationReq.Settings, &settings)
 	if err != nil {
 		return Settings{}, err
 	}
 
-	return NewSettingsFromRaw(&rawSettings), nil
+	return settings, nil
 }
 
 // The AllowPorts and DenyPorts should not have any
@@ -41,16 +31,37 @@ func (s *Settings) Valid() bool {
 	return common.Cardinality() == 0
 }
 
+func (s *Settings) UnmarshalJSON(data []byte) error {
+	// This is needed becaus golang-set v2.3.0 has a bug that prevents
+	// the correct unmarshalling of ThreadUnsafeSet types.
+	rawSettings := struct {
+		RequireTls bool     `json:"requireTLS"`
+		AllowPorts []uint64 `json:"allowPorts"`
+		DenyPorts  []uint64 `json:"denyPorts"`
+	}{}
+
+	err := json.Unmarshal(data, &rawSettings)
+	if err != nil {
+		return err
+	}
+
+	s.RequireTls = rawSettings.RequireTls
+	s.AllowPorts = mapset.NewThreadUnsafeSet[uint64](rawSettings.AllowPorts...)
+	s.DenyPorts = mapset.NewThreadUnsafeSet[uint64](rawSettings.DenyPorts...)
+
+	return nil
+}
+
 func validateSettings(payload []byte) ([]byte, error) {
-	rawSettings := RawSettings{}
-	err := easyjson.Unmarshal(payload, &rawSettings)
+	settings := Settings{}
+	err := json.Unmarshal(payload, &settings)
 	if err != nil {
 		return []byte{}, err
 	}
 
-	settings := NewSettingsFromRaw(&rawSettings)
 	if settings.Valid() {
 		return kubewarden.AcceptSettings()
 	}
+
 	return kubewarden.RejectSettings(kubewarden.Message("No port can be allowed and denied at the same time"))
 }

settings.go

@@ -1,13 +1,14 @@
 package main
 
 import (
+	"encoding/json"
 	"testing"
 
+	mapset "github.com/deckarep/golang-set/v2"
 	networkingv1 "github.com/kubewarden/k8s-objects/api/networking/v1"
 	metav1 "github.com/kubewarden/k8s-objects/apimachinery/pkg/apis/meta/v1"
 	kubewarden_protocol "github.com/kubewarden/policy-sdk-go/protocol"
 	kubewarden_testing "github.com/kubewarden/policy-sdk-go/testing"
-	"github.com/mailru/easyjson"
 )
 
 func TestParsingSettingsWithAllValuesProvidedFromValidationReq(t *testing.T) {
@@ -18,18 +19,18 @@ func TestParsingSettingsWithAllValuesProvidedFromValidationReq(t *testing.T) {
 		},
 	}
 
-	rawSettings := RawSettings{
+	expectedSettings := Settings{
 		RequireTls: true,
-		AllowPorts: []uint64{443},
-		DenyPorts:  []uint64{80, 8080},
+		AllowPorts: mapset.NewThreadUnsafeSet[uint64](443),
+		DenyPorts:  mapset.NewThreadUnsafeSet[uint64](80, 8080),
 	}
 
-	validationReqRaw, err := kubewarden_testing.BuildValidationRequest(ingress, rawSettings)
+	validationReqRaw, err := kubewarden_testing.BuildValidationRequest(ingress, &expectedSettings)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
 	validationReq := kubewarden_protocol.ValidationRequest{}
-	err = easyjson.Unmarshal(validationReqRaw, &validationReq)
+	err = json.Unmarshal(validationReqRaw, &validationReq)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
@@ -63,18 +64,18 @@ func TestParsingSettingsWithSomeValuesProvided(t *testing.T) {
 		},
 	}
 
-	rawSettings := RawSettings{
+	expectedSettings := Settings{
 		RequireTls: false,
-		AllowPorts: []uint64{443},
-		DenyPorts:  []uint64{},
+		AllowPorts: mapset.NewThreadUnsafeSet[uint64](443),
+		DenyPorts:  mapset.NewThreadUnsafeSet[uint64](),
 	}
 
-	validationReqRaw, err := kubewarden_testing.BuildValidationRequest(ingress, rawSettings)
+	validationReqRaw, err := kubewarden_testing.BuildValidationRequest(ingress, expectedSettings)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
 	validationReq := kubewarden_protocol.ValidationRequest{}
-	err = easyjson.Unmarshal(validationReqRaw, &validationReq)
+	err = json.Unmarshal(validationReqRaw, &validationReq)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
@@ -105,13 +106,8 @@ func TestParsingSettingsFromValidateSettingsPayload(t *testing.T) {
 		"denyPorts": [ 80, 8080 ]
 	}
 	`
-	rawRequest := RawSettings{}
-	err := easyjson.Unmarshal([]byte(request), &rawRequest)
-	if err != nil {
-		t.Errorf("Unexpected error %+v", err)
-	}
-
-	settings := NewSettingsFromRaw(&rawRequest)
+	settings := Settings{}
+	err := json.Unmarshal([]byte(request), &settings)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
@@ -140,13 +136,8 @@ func TestSettingsAreValid(t *testing.T) {
 		"denyPorts": [ 80, 8080 ]
 	}
 	`
-	rawRequest := RawSettings{}
-	err := easyjson.Unmarshal([]byte(request), &rawRequest)
-	if err != nil {
-		t.Errorf("Unexpected error %+v", err)
-	}
-
-	settings := NewSettingsFromRaw(&rawRequest)
+	settings := Settings{}
+	err := json.Unmarshal([]byte(request), &settings)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}
@@ -164,13 +155,8 @@ func TestSettingsAreNotValid(t *testing.T) {
 		"denyPorts": [ 80, 8080 ]
 	}
 	`
-	rawRequest := RawSettings{}
-	err := easyjson.Unmarshal([]byte(request), &rawRequest)
-	if err != nil {
-		t.Errorf("Unexpected error %+v", err)
-	}
-
-	settings := NewSettingsFromRaw(&rawRequest)
+	settings := Settings{}
+	err := json.Unmarshal([]byte(request), &settings)
 	if err != nil {
 		t.Errorf("Unexpected error %+v", err)
 	}