Add test/check sanity to check if test-framework mock data is updated (#2131)

* add to the sanity check to ensure that the test-framework is updated
* Ensure that all scripts has the same name format with - and not _
* create makefile target for the new check
* improve doc gen and make file targets related to it.

Author: camilamacedo86

Makefile

@@ -54,8 +54,14 @@ tidy: ## Update dependencies
 clean: ## Clean up the build artifacts
 	$(Q)rm -rf build
 
-cli-doc: ## Generate CLI Documentation
-	./hack/doc/gen_cli_doc.sh
+gen-cli-doc: ## Generate CLI documentation
+	./hack/generate/gen-cli-doc.sh
+
+gen-test-framework: install ## Run generate commands to update test/test-framework
+	./hack/generate/gen-test-framework.sh
+
+generate: gen-cli-doc gen-test-framework  ## Run all generate targets
+.PHONY: generate gen-cli-doc gen-test-framework
 
 # Build/install/release the SDK.
 .PHONY: install release_builds release
@@ -112,7 +118,7 @@ test: test-unit ## Run the tests
 test-markdown test/markdown:
 	./hack/ci/marker
 
-test-sanity test/sanity: tidy
+test-sanity test/sanity: tidy build/operator-sdk
 	./hack/tests/sanity-check.sh
 
 test-unit test/unit: ## Run the unit tests

go.mod

@@ -18,7 +18,6 @@ require (
 	github.com/ghodss/yaml v1.0.1-0.20180820084758-c7ce16629ff4
 	github.com/go-logr/logr v0.1.0
 	github.com/go-logr/zapr v0.1.1
-	github.com/go-openapi/spec v0.19.0
 	github.com/gobuffalo/packr v1.30.1 // indirect
 	github.com/gobwas/glob v0.2.3 // indirect
 	github.com/huandu/xstrings v1.2.0 // indirect

hack/check_error_log_msg_format.sh renamed to hack/check-error-log-msg-format.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+go run ./hack/generate/gen-cli-doc.go

hack/check_license.sh renamed to hack/check-license.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+#############################
+# Make sure that test/test-framework is updated according to the current source code
+#############################
+
+set -ex
+
+source hack/lib/test_lib.sh
+
+# Define vars
+DOCKERFILE="build/Dockerfile"
+
+# Go inside of the mock data test project
+cd test/test-framework
+
+# Create the required files in the mock test/test-framework just to allow run from it the oprator-sdk commands
+echo > $DOCKERFILE
+go mod init test-framework
+
+# Remove files that are required and created just to exec the commands.
+trap_add 'rm -rf $DOCKERFILE go.mod go.sum' EXIT
+
+# Run gen commands
+../../build/operator-sdk generate k8s
+../../build/operator-sdk generate openapi
+
+# TODO(camilamacedo86): remove this when the openapi gen be set to false and it no longer is generated
+# The following file is gen by openapi but it has not been committed in order to allow we clone and call the test locally in any path.
+trap_add 'rm pkg/apis/cache/v1alpha1/zz_generated.openapi.go' EXIT

hack/doc/gen_cli_doc.sh

@@ -5,9 +5,10 @@ go mod tidy
 go vet ./...
 go fmt ./...
 
-./hack/check_license.sh
-./hack/check_error_log_msg_format.sh
-./hack/doc/gen_cli_doc.sh
+./hack/check-license.sh
+./hack/check-error-log-msg-format.sh
+./hack/generate/gen-cli-doc.sh
+./hack/generate/gen-test-framework.sh
 
 # Make sure repo is still in a clean state.
 git diff --exit-code