feat: add magefile

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
coreruleset · Jul 26, 2023 · 29c6c1c · 29c6c1c
1 parent 750f77d
commit 29c6c1c
Show file tree

Hide file tree

Showing 66 changed files with 360 additions and 23 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,6 @@
+# Copyright 2023 OWASP ModSecurity Core Rule Set Project
+# SPDX-License-Identifier: Apache-2.0
+
 FROM alpine:3
 
 RUN apk add --no-cache ca-certificates

diff --git a/check/base.go b/check/base.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (

diff --git a/check/base_test.go b/check/base_test.go
@@ -1,15 +1,17 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (
 	"sort"
 	"testing"
 
-	"github.com/coreruleset/go-ftw/utils"
-
 	"github.com/stretchr/testify/suite"
 
 	"github.com/coreruleset/go-ftw/config"
 	"github.com/coreruleset/go-ftw/test"
+	"github.com/coreruleset/go-ftw/utils"
 )
 
 var configMap = map[string]string{

diff --git a/check/error.go b/check/error.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import "github.com/rs/zerolog/log"

diff --git a/check/error_test.go b/check/error_test.go
@@ -1,14 +1,16 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (
 	"errors"
 	"testing"
 
-	"github.com/coreruleset/go-ftw/utils"
-
 	"github.com/stretchr/testify/suite"
 
 	"github.com/coreruleset/go-ftw/config"
+	"github.com/coreruleset/go-ftw/utils"
 )
 
 var expectedOKTests = []struct {

diff --git a/check/logs.go b/check/logs.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 // AssertNoLogContains returns true is the string is not found in the logs

diff --git a/check/logs_test.go b/check/logs_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (

diff --git a/check/response.go b/check/response.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (

diff --git a/check/response_test.go b/check/response_test.go
@@ -1,13 +1,15 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (
 	"testing"
 
-	"github.com/coreruleset/go-ftw/utils"
-
 	"github.com/stretchr/testify/suite"
 
 	"github.com/coreruleset/go-ftw/config"
+	"github.com/coreruleset/go-ftw/utils"
 )
 
 var expectedResponseOKTests = []struct {

diff --git a/check/status.go b/check/status.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 // AssertStatus will match the expected status list with the one received in the response

diff --git a/check/status_test.go b/check/status_test.go
@@ -1,13 +1,15 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package check
 
 import (
 	"testing"
 
-	"github.com/coreruleset/go-ftw/utils"
-
 	"github.com/stretchr/testify/suite"
 
 	"github.com/coreruleset/go-ftw/config"
+	"github.com/coreruleset/go-ftw/utils"
 )
 
 var statusOKTests = []struct {

diff --git a/cmd/check.go b/cmd/check.go
@@ -1,11 +1,15 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (
 	"fmt"
 
-	"github.com/coreruleset/go-ftw/test"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
+
+	"github.com/coreruleset/go-ftw/test"
 )
 
 // NewCheckCmd represents the check command

diff --git a/cmd/check_test.go b/cmd/check_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (

diff --git a/cmd/root.go b/cmd/root.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (

diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (

diff --git a/cmd/run.go b/cmd/run.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (
@@ -9,15 +12,14 @@ import (
 
 	"github.com/go-logr/zerologr"
 	"github.com/rs/zerolog/log"
-	"wait4x.dev/v2/waiter"
-
+	"github.com/spf13/cobra"
 	"wait4x.dev/v2/checker"
 	"wait4x.dev/v2/checker/http"
+	"wait4x.dev/v2/waiter"
 
 	"github.com/coreruleset/go-ftw/output"
 	"github.com/coreruleset/go-ftw/runner"
 	"github.com/coreruleset/go-ftw/test"
-	"github.com/spf13/cobra"
 )
 
 // NewRunCmd represents the run command

diff --git a/cmd/run_test.go b/cmd/run_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package cmd
 
 import (

diff --git a/config/config.go b/config/config.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package config
 
 import (

diff --git a/config/config_test.go b/config/config_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package config
 
 import (

diff --git a/config/types.go b/config/types.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package config
 
 import (

diff --git a/ftwhttp/client.go b/ftwhttp/client.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/client_test.go b/ftwhttp/client_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/connection.go b/ftwhttp/connection.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 // Package ftwhttp provides low level abstractions for sending/receiving raw http messages
 package ftwhttp
 

diff --git a/ftwhttp/connection_test.go b/ftwhttp/connection_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/header.go b/ftwhttp/header.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/request.go b/ftwhttp/request.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/request_test.go b/ftwhttp/request_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/response.go b/ftwhttp/response.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 // GetFullResponse gives the full response as string, or nil if there was some error

diff --git a/ftwhttp/response_test.go b/ftwhttp/response_test.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/ftwhttp/rtt.go b/ftwhttp/rtt.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import "time"

diff --git a/ftwhttp/types.go b/ftwhttp/types.go
@@ -1,3 +1,6 @@
+// Copyright 2023 OWASP ModSecurity Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
 package ftwhttp
 
 import (

diff --git a/go.mod b/go.mod
@@ -10,6 +10,7 @@ require (
 	github.com/icza/backscanner v0.0.0-20220812133752-2e60bffed4a2
 	github.com/knadh/koanf v1.5.0
 	github.com/kyokomi/emoji v2.2.4+incompatible
+	github.com/magefile/mage v1.15.0
 	github.com/rs/zerolog v1.29.1
 	github.com/spf13/cobra v1.7.0
 	github.com/stretchr/testify v1.8.4

diff --git a/go.sum b/go.sum
@@ -191,6 +191,8 @@ github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kyokomi/emoji v2.2.4+incompatible h1:np0woGKwx9LiHAQmwZx79Oc0rHpNw3o+3evou4BEPv4=
 github.com/kyokomi/emoji v2.2.4+incompatible/go.mod h1:mZ6aGCD7yk8j6QY6KICwnZ2pxoszVseX1DNoGtU2tBA=
 github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
+github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=
+github.com/magefile/mage v1.15.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=

diff --git a/mage.go b/mage.go
@@ -0,0 +1,19 @@
+// Copyright 2023 OWASP Core Rule Set Project
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build ignore
+// +build ignore
+
+// Entrypoint to mage for running without needing to install the command.
+// https://magefile.org/zeroinstall/
+package main
+
+import (
+	"os"
+
+	"github.com/magefile/mage/mage"
+)
+
+func main() {
+	os.Exit(mage.Main())
+}