10000 Refactor Makefile and Docs Script to Reduce Code Duplication by Weltraumschaf · Pull Request #959 · secureCodeBox/secureCodeBox · GitHub
[go: up one dir, main page]
Skip to content

Refactor Makefile and Docs Script to Reduce Code Duplication #959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Weltraumschaf merged 16 commits into from
Feb 16, 2022
Merged

Refactor Makefile and Docs Script to Reduce Code Duplication #959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8372e9c
#754 Extract the list of node packages into variable
Weltraumschaf Feb 3, 2022
b207a0b
#754 Extract target to install operator
Weltraumschaf Feb 3, 2022
2092e95
Use make built in to find files
Weltraumschaf Feb 4, 2022
f9898a8
Remove argument which is always the same
Weltraumschaf Feb 4, 2022
03dce79
#754 Extract check for docs dir into main function
Weltraumschaf Feb 4, 2022
e599505
#754 Add some question markers
Weltraumschaf Feb 7, 2022
0634e90
#754 Rename doc generation script
Weltraumschaf Feb 8, 2022
58c8ef8
#754 Extract docs dir name into single variable
Weltraumschaf Feb 8, 2022
98f94ef
#754 Add function to generate the top level READMEs
Weltraumschaf Feb 8, 2022
6f4f9d6
#754 Rename var to reflect the dual use of it
Weltraumschaf Feb 8, 2022
327c854
#754 Add missing slash in template path for auto discovery docs
Weltraumschaf Feb 8, 2022
95d9987
#754 Use generator script to generate top level READMEs
Weltraumschaf Feb 8, 2022
eceb125
#754 Remove quotes from Makefile
Weltraumschaf Feb 8, 2022
72e0909
#754 Answer the XXX tags
Weltraumschaf Feb 8, 2022
c5676ea
#754 Remove redundant argument of local template
Weltraumschaf Feb 8, 2022
4aff687
#754 Derive the template name from output file name
Weltraumschaf Feb 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 50 additions & 47 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,79 +13,82 @@ HELM_DOCS_DIR = $(PROJECT_DIR)/.helm-docs
TEMPLATES_DIR = $(PROJECT_DIR)/.templates

SCANNERS_CHART_LIST := $(sort $(wildcard $(SCANNERS_DIR)/*/Chart.yaml))
SCANNERS_TEST_LIST := $(sort $(wildcard $(SCANNERS_DIR)/*/Makefile))
HOOKS_CHART_LIST := $(sort $(wildcard $(HOOKS_DIR)/*/Chart.yaml))
HOOKS_TEST_LIST := $(sort $(wildcard $(HOOKS_DIR)/*/Makefile))
DEMO_TARGETS_CHART_LIST := $(sort $(wildcard $(DEMO_TARGETS_DIR)/*/Chart.yaml))
# This find construct is based on https://stackoverflow.com/questions/4210042/how-to-exclude-a-directory-in-find-command/4210072#4210072
PACKAGE_JSON_LIST := $(shell find $(PROJECT_DIR) \( \
-name .git -o \
-name .github -o \
-name .idea -o \
-name .reuse -o \
-name .vagrant -o \
-name .vscode -o \
-name bin -o \
-name docs -o \
-name LICENSES -o \
-name coverage -o \
-name dist -o \
-name node_modules -o \
-name target \) \
-prune \
-false \
-o -type f \
-iname package.json)

all: help

.PHONY: npm-ci-all
npm-ci-all: ## Runs npm ci in all node module subfolders.
# This find construct is based on https://stackoverflow.com/questions/4210042/how-to-exclude-a-directory-in-find-command/4210072#4210072
find . \( \
-name '.git' -o \
-name '.github' -o \
-name '.idea' -o \
-name '.reuse' -o \
-name '.vagrant' -o \
-name '.vscode' -o \
-name 'bin' -o \
-name 'docs' -o \
-name 'LICENSES' -o \
-name 'coverage' -o \
-name 'dist' -o \
-name 'node_modules' -o \
-name target \) \
-prune \
-false \
-o -type f \
-iname package.json \
-execdir npm ci \;
@for package in $(PACKAGE_JSON_LIST); do \
cd $$(dirname $${package}) && npm ci; \
done

.PHONY: npm-test-all
npm-test-all: ## Runs all Jest based test suites.
npm test -- --testPathIgnorePatterns "/integration-tests/"
npm test -- --testPathIgnorePatterns /integration-tests/

.PHONY: test-all
test-all: ## Runs all makefile based test suites.
@echo ".: ⚙ Installing the operator for makefile based testing."
cd ./operator && $(MAKE) -s docker-build docker-export kind-import helm-deploy
@echo ".: ⚙ Running make test for all scanner and hook modules."
for dir in scanners/*/ hooks/*/ ; do \
cd $$dir; \
echo ".: ⚙ Running make test for '$$dir'."; \
$(MAKE) -s test || exit 1 ; \
cd -; \
done;
test-all: install-operator ## Runs all makefile based test suites.
@echo "Running make test for all scanner and hook modules..."
@for dir in $(SCANNERS_TEST_LIST) $(HOOKS_TEST_LIST); do \
cd $$(dirname $$dir) && $(MAKE) -s test || exit 1; \
done

.PHONY: install-operator
install-operator: ## Install the operator for makefile based testing.
@echo "Installing the operator for makefile based testing..."
cd $(OPERATOR_DIR) && $(MAKE) -s docker-build docker-export kind-import helm-deploy

.PHONY: readme
readme: ## Generate README.md based on Chart.yaml and template.
@echo ".: ⚙ Generate Helm Docs."
helm-docs --template-files=$(HELM_DOCS_DIR)/templates.gotmpl --template-files=.helm-docs.gotmpl --template-files=$(HELM_DOCS_DIR)/README.md.gotmpl
$(BIN_DIR)/generate-helm-docs.sh --readme $(PROJECT_DIR) $(HELM_DOCS_DIR)

.PHONY: hook-docs
hook-docs: ## Generate documentation for hooks.
@for chart in $(HOOKS_CHART_LIST); do \
$(BIN_DIR)/generate-docs.sh --hook "$${chart}" $(HELM_DOCS_DIR); \
$(BIN_DIR)/generate-helm-docs.sh --hook $${chart} $(HELM_DOCS_DIR); \
done

.PHONY: scanner-docs
scanner-docs: ## Generate documentation for scanners.
@for chart in $(SCANNERS_CHART_LIST); do \
$(BIN_DIR)/generate-docs.sh --scanner "$${chart}" $(HELM_DOCS_DIR); \
$(BIN_DIR)/generate-helm-docs.sh --scanner $${chart} $(HELM_DOCS_DIR); \
done

.PHONY: operator-docs
operator-docs: ## Generate documentation for the operator.
$(BIN_DIR)/generate-docs.sh --operator $(OPERATOR_DIR)/Chart.yaml $(HELM_DOCS_DIR)
$(BIN_DIR)/generate-helm-docs.sh --operator $(OPERATOR_DIR)/Chart.yaml $(HELM_DOCS_DIR)

.PHONY: auto-discovery-docs
auto-discovery-docs: ## Generate documentation for the auto-discovery.
$(BIN_DIR)/generate-docs.sh --operator $(AUTO_DISCOVERY_DIR)/kubernetes/Chart.yaml $(HELM_DOCS_DIR)
$(BIN_DIR)/generate-helm-docs.sh --operator $(AUTO_DISCOVERY_DIR)/kubernetes/Chart.yaml $(HELM_DOCS_DIR)

.PHONY: demo-target-docs
demo-target-docs: ## Generate documentation for demo targets.
@for chart in $(DEMO_TARGETS_CHART_LIST); do \
$(BIN_DIR)/generate-docs.sh --demo-target "$${chart}" $(HELM_DOCS_DIR); \
$(BIN_DIR)/generate-helm-docs.sh --demo-target $${chart} $(HELM_DOCS_DIR); \
done

.PHONY: docs
Expand All @@ -94,15 +97,15 @@ docs: readme hook-docs scanner-docs operator-docs auto-discovery-docs demo-targe
.PHONY: create-new-scanner
create-new-scanner: ## Creates templates for a new scanner, pass NAME=NEW-SCANNER to this target.
ifdef NAME
rm -rf "$(SCANNERS_DIR)/$(NAME)"
cp -r "$(TEMPLATES_DIR)/new-scanner/" "$(SCANNERS_DIR)/$(NAME)"
find $(SCANNERS_DIR)/$(NAME) -type f ! -name 'tmp' \
-exec sed -n "s/new-scanner/$(NAME)/g;w $(SCANNERS_DIR)/$(NAME)/tmp" {} \; \
-exec mv "$(SCANNERS_DIR)/$(NAME)/tmp" {} \;
mv "$(SCANNERS_DIR)/$(NAME)/templates/new-scanner-parse-definition.yaml" \
"$(SCANNERS_DIR)/$(NAME)/templates/$(NAME)-parse-definition.yaml"
mv "$(SCANNERS_DIR)/$(NAME)/templates/new-scanner-scan-type.yaml" \
"$(SCANNERS_DIR)/$(NAME)/templates/$(NAME)-scan-type.yaml"
rm -rf $(SCANNERS_DIR)/$(NAME)
cp -r $(TEMPLATES_DIR)/new-scanner/ $(SCANNERS_DIR)/$(NAME)
find $(SCANNERS_DIR)/$(NAME) -type f ! -name tmp \
-exec sed -n s/new-scanner/$(NAME)/g;w $(SCANNERS_DIR)/$(NAME)/tmp {} \; \
-exec mv $(SCANNERS_DIR)/$(NAME)/tmp {} \;
mv $(SCANNERS_DIR)/$(NAME)/templates/new-scanner-parse-definition.yaml \
$(SCANNERS_DIR)/$(NAME)/templates/$(NAME)-parse-definition.yaml
mv $(SCANNERS_DIR)/$(NAME)/templates/new-scanner-scan-type.yaml \
$(SCANNERS_DIR)/$(NAME)/templates/$(NAME)-scan-type.yaml
else
@echo "Scanner name not defined, please provide via make create-new-scanner NAME=NEW-SCANNER"
endif
Expand Down
238 changes: 0 additions & 238 deletions bin/generate-docs.sh
View file
Open in desktop

This file was deleted.

Loading
0