From bbe4c002c8aa9df1f4f92529fcc2bc49515c2b11 Mon Sep 17 00:00:00 2001
From: corverroos <corver.roos@gmail.com>
Date: Fri, 28 Apr 2023 10:55:20 +0200
Subject: [PATCH] precommit: lint importing of testutil

---
 .pre-commit-config.yaml     |  5 +++++
 .pre-commit/run_testutil.sh | 27 +++++++++++++++++++++++++++
 app/app.go                  |  2 +-
 app/vmock.go                |  2 +-
 tools.go                    |  2 ++
 5 files changed, 36 insertions(+), 2 deletions(-)
 create mode 100755 .pre-commit/run_testutil.sh

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 76d173fe4..5ed3cba64 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -64,3 +64,8 @@ repos:
         entry: .pre-commit/run_regexp.sh
         types: [ file, go ]
         exclude: "_test.go"
+      - id: run-testutil
+        name: run-testutil
+        language: script
+        entry: .pre-commit/run_testutil.sh
+        types: [ file, go ]
diff --git a/.pre-commit/run_testutil.sh b/.pre-commit/run_testutil.sh
new file mode 100755
index 000000000..113db9a48
--- /dev/null
+++ b/.pre-commit/run_testutil.sh
@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+FILES=$@
+
+# check runs a regexp check on the given files
+function check() {
+    grep -HnE "$2" $FILES && printf "\n❌ Regexp check failed: %s\n\n" "$1"
+}
+
+# exclude_names excludes file names matching the given regex from the list of files
+function exclude_names() {
+     FILES=$(echo $FILES | tr ' ' '\n' | grep -vE "$1" | tr '\n' ' ')
+}
+
+# exclude_names excludes files with content matching the given regex from the list of files
+function exclude_content() {
+      FILES=$(echo $FILES | tr ' ' '\n' | xargs grep -LZE "$1" | tr '\n' ' ')
+}
+
+# Exclude all file names with 'test' in the path.
+exclude_names 'test'
+exclude_content '// Allow testutil'
+
+# These checks apply to all non-test files
+check 'Testutil package may only be imported by tests' 'github.com/obolnetwork/charon/testutil' && exit 1
+
+true
diff --git a/app/app.go b/app/app.go
index 19bc5b692..c234969a8 100644
--- a/app/app.go
+++ b/app/app.go
@@ -58,7 +58,7 @@ import (
 	"github.com/obolnetwork/charon/p2p"
 	"github.com/obolnetwork/charon/tbls"
 	"github.com/obolnetwork/charon/tbls/tblsconv"
-	"github.com/obolnetwork/charon/testutil/beaconmock"
+	"github.com/obolnetwork/charon/testutil/beaconmock" // Allow testutil
 )
 
 const eth2ClientTimeout = time.Second * 2
diff --git a/app/vmock.go b/app/vmock.go
index d83f9b8e0..709b8018c 100644
--- a/app/vmock.go
+++ b/app/vmock.go
@@ -18,7 +18,7 @@ import (
 	"github.com/obolnetwork/charon/core"
 	"github.com/obolnetwork/charon/eth2util"
 	"github.com/obolnetwork/charon/eth2util/keystore"
-	"github.com/obolnetwork/charon/testutil/validatormock"
+	"github.com/obolnetwork/charon/testutil/validatormock" // Allow testutil
 )
 
 // wireValidatorMock wires the validator mock if enabled. It connects via http validatorapi.Router.
diff --git a/tools.go b/tools.go
index 2ed88eeae..868b19b2a 100644
--- a/tools.go
+++ b/tools.go
@@ -8,6 +8,8 @@ package main
 // This file contains build time developer tools used in the charon repo.
 // To install all the tools run: go generate tools.go
 
+// Allow testutil
+
 import (
 	_ "github.com/bufbuild/buf/cmd/buf"
 	_ "golang.org/x/tools/cmd/stringer"