Makefile

# /!\ /!\ /!\ /!\ /!\ /!\ /!\ DISCLAIMER /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\/!\ /!\ /!\/!\
#
# This Makefile is only meant to be used for DEVELOPMENT purpose as we are
# changing the user id that will run in the container.
#
# PLEASE DO NOT USE IT FOR YOUR PRODUCTION...
#
# /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\/!\ /!\ /!\/!\
########################################################################################
# How-to use
########################################################################################
# Run the make with as follow:
#
# ```bash
# make ${make_target} \
#      version_repo="X.Y.Z" \
#      tag_message = "the message your may want to associate with the Git tag" \
# ```

BOLD := \033[1m
RESET := \033[0m
GREEN := \033[1;32m
RED := \033[31m
BOLD_GREEN := \033[1;32m

########################################################################################
# PREAMBLE - OS AND DEPENDENCY CHECKS
########################################################################################
# Detect OS
UNAME_S := $(shell uname -s)
ifeq ($(UNAME_S),Linux)
    $(info ✅ Running on Linux)
    OS := Linux
	# Detect package manager
    ifneq (,$(shell command -v apt 2> /dev/null))
        PKG_MANAGER := apt
    else ifneq (,$(shell command -v dnf 2> /dev/null))
        PKG_MANAGER := dnf
    else ifneq (,$(shell command -v yum 2> /dev/null))
        PKG_MANAGER := yum
    else ifneq (,$(shell command -v zypper 2> /dev/null))
        PKG_MANAGER := zypper
    else ifneq (,$(shell command -v pacman 2> /dev/null))
        PKG_MANAGER := pacman
    else
        $(error ❌ Unable to detect package manager (apt, dnf, yum, zypper, or pacman))
    endif
    $(info ✅ Package manager detected: $(PKG_MANAGER))
else ifeq ($(UNAME_S),Darwin)
    $(info ✅ Running on macOS)
    OS := macOS
else
    $(error ❌ Unsupported OS: $(UNAME_S). Only Linux and macOS are supported.)
endif
UNAME_S :=

# Check for bash

ifeq (,$(shell command -v bash 2> /dev/null))
    $(error ❌ bash not found. Please install bash.)
else
    $(info ✅ bash found: $(shell command -v bash))
endif

# Check for uv
ifeq (,$(shell command -v uv 2> /dev/null))
    $(error ❌ uv not found. Please install uv, ideally with your package manager, or from https://github.com/astral-sh/uv)
else
    UV_VERSION := $(shell uv --version 2>/dev/null)
    $(info ✅ uv found: $(UV_VERSION))
endif
UV_VERSION :=


########################################################################################
# VARIABLES
########################################################################################

# Use Bash and its facilities
SHELL := /bin/bash

# Extract Python version from pyproject.toml and create .python-version
# This file is needed by uv and pip for building the bundle
# We also include it into the .tar.gz bundle.
$(shell \
  if [ ! -f .python-version ]; then \
python3 -c "import tomllib; \
data = tomllib.load(open('pyproject.toml', 'rb')); \
req = data['project']['requires-python']; \
version = req.replace('>=', '').split('.')[0:2]; \
print('.'.join(version))" > .python-version 2>/dev/null || echo "3.13" > .python-version; \
  fi \
)

# Setup environments
# We include files if they exists, or create them from templates for init_repo recipe
ifneq ($(wildcard ./.envinit),)
include .envinit
export $(shell sed 's/=.*//' .envinit)
endif

# Check for the presence of envfiles
envfiles := .envbuild .envtest .envdev .env
env_file_non_present := 0

define check_envfile
ifeq ($$(wildcard ./$(1)),)
$$(info $(1) file was created from template.)
$$(shell cp $(1).template $(1))
$$(eval env_file_non_present := 1)
endif
endef

$(foreach envfile,$(envfiles),$(eval $(call check_envfile,$(envfile))))

ifeq ($(env_file_non_present),1)
$(shell echo -e "$(RED)$(BOLD)At least one envfile was recreated from template, please modify varenvs: run configure_repo_dev or manually.$(RESET)" >&2)
$(error ❌ Please correct and run again. ❌)
endif
env_file_non_present :=
envfile :=

# Include their content on next runs
-include $(envfiles)
$(foreach file,$(envfiles),$(eval export $(shell sed 's/=.*//' $(file))))


# Build intermediary variables
# We currently use the debian convention at some level
# Even if our package is not really a debian package yet
PACKAGE_VERSION = $(shell cat VERSION)
PACKAGE_PYTHON = $(shell cat .python-version)
PACKAGE_SUFFIX = deployment-bundle.tar.gz
PACKAGE_FULLNAME = ${PACKAGENAME}_v${PACKAGE_VERSION}_Python${PACKAGE_PYTHON}-${PACKAGE_SUFFIX}

# Houskeeping forcing variables
# We reserve normally automation for CI/CD - Experimental in this repo
automatic = "N"
#
# this one is to bump version, different from PACKAGE_VERSION which only reads Version state
version_repo = "0.0.0"
#
tag_message = ""
venv_dir = ".venv"
venv_command = ". $(venv_dir)/bin/activate"
#
new_package = ""

target_url = "https://www.google.com"

########################################################################################
# RULES
########################################################################################

.SILENT:
.PHONY: configure_repo_dev \
		clean \
		testclean \
		distclean \
		coverageclean \
		nuke

# Init
########################################################################################
configure_repo_dev: install-dev
# TODO Help the User to create the .envdev and .env files
	uv sync --locked; \
	echo "${venv_command}"; \
	uv run pip3 list; \
	go_to_install="N"; \
	if [ ${automatic} = "N" ]; then \
		echo "Reply Y if and only if the pip3 list output above is consistent and does not display system packages !"; \
		echo "Ctrl+C to escape ..."; \
		read -p "Do you want to install other specific dependencies from specific requirement files with pip ? (Y/N) " go_to_install; \
		if [ $$go_to_install = "Y" ] || [ $$go_to_install = "y" ]; then \
			uv run pip3 install -r requirements-dev.txt -e .; \
		else \
			echo "Tweak requirements-dev.txt skipped"; \
		fi; \
	fi;
	uv run pre-commit install; \
	uv run pre-commit autoupdate; \
	echo "Initial pre-commit run"; \
	uv run pre-commit run --all-files; \
	echo "Virtual environment created, local repo configured with pre-commit hooks."; \
	cd /tmp; \
	# git clone TODO ADD Github stuff

# Development lifecycle #
########################################################################################
# Dependencies
# -dev suffixes means we specifically manage dependencies present only in Dev Environment
install_deps:
	uv pip install pip
	uv venv --seed
	uv sync --locked

install-dev:
	uv pip install pip
	uv venv --seed
	uv sync --dev --locked

add_newdep:
	uv add $(new_package)

add_newdep-dev:
	uv add --dev $(new_package)

update_deps:
	uv lock --upgrade
	uv sync --locked

update_deps-dev:
	uv lock --upgrade
	uv sync --dev --locked
########################################################################################

# Run Application
run:
	uv run src/url_checker_tools.py \
	  ${target_url};

run_robot:
	uv run src/url_checker_tools.py \
	  --providers urlhaus,virustotal,yara \
	  --format synthesis \
	  ${target_url};

malrun_robot:
	uv run src/url_checker_tools.py \
	  --providers virustotal \
	  --format synthesis \
	  --verbose \
	  "https://malware.wicar.org";
########################################################################################

# Build 🌍 , Publish  🌬️ and Release 🔥
build: update_deps clean
	set -e; \
	trap '$(MAKE) configure_repo_dev' EXIT \
	# Export uv.lock to requirements-build.txt for downloading \
	echo "Create requirements-build.txt"; \
	uv export \
	  --format requirements.txt \
	  --no-hashes \
	  --frozen \
	  --no-editable \
	  --no-emit-project > requirements-build.txt; \
	# Export all wheel \
	echo "Download wheel"; \
	mkdir -p offline-wheels; \
	# Download ONLY the locked dependencies for this project \
	uv run pip download \
	  -r requirements-build.txt \
	  --dest offline-wheels/ \
      --prefer-binary \
	# Add build package tools \
	# python3 -m pip download setuptools wheel pip --dest offline-wheels/ \
	python3 -m pip download \
	  setuptools \
	  --dest offline-wheels \
	  --prefer-binary \
	# Bundle everything \
	echo "Bundle it in ${PACKAGE_FULLNAME}"; \
	tar czf ${PACKAGE_FULLNAME} \
	  --transform='s|^src/$(PACKAGENAME)|$(PACKAGENAME)|' \
	  --transform='s|^src/$(PACKAGENAME).py|$(PACKAGENAME).py|' \
      src/$(PACKAGENAME) \
	  src/$(PACKAGENAME).py \
	  doc \
	  Makefile \
	  .env.template \
	  .python-version \
      pyproject.toml \
	  requirements-build.txt \
      uv.lock \
	  CHANGELOG.md \
	  CONTRIBUTORS.md \
	  UPGRADING_NOTES.md \
	  README.md \
	  RELEASE_NOTES.md \
	  VERSION \
	  offline-wheels;

publish:
    # Configuration
	read -s -p "GitLab Token: " GITLAB_TOKEN; \
	echo "Publishing to GitLab Package Registry..."; \
	echo "--upload-file ${PACKAGE_FULLNAME}"; \
	echo "${URLCHECKERTOOLS_GITLAB_CI_API_V4_URL}/projects/${URLCHECKERTOOLS_GITLAB_PROJECT_ID}/packages/generic/${PACKAGE_DEBIANNAME}/${PACKAGE_VERSION}/${PACKAGE_FULLNAME}"; \
	curl --header "PRIVATE-TOKEN: $$GITLAB_TOKEN" \
	  --upload-file ${PACKAGE_FULLNAME} \
	  "${URLCHECKERTOOLS_GITLAB_CI_API_V4_URL}/projects/${URLCHECKERTOOLS_GITLAB_PROJECT_ID}/packages/generic/${PACKAGE_DEBIANNAME}/${PACKAGE_VERSION}/${PACKAGE_FULLNAME}"; \
	echo "✅ Published: ${PACKAGE_DEBIANNAME} version is ${PACKAGE_VERSION}"

release: build publish
	@echo "✅ Release complete"
########################################################################################

# Test
########################################################################################
# Unit tests
test_units:
	uv run python tests/run_tests.py; \
	#uv run pytest --cov=src/"${PACKAGENAME}" -n auto -v --capture=no; \
	#uv run pytest -m unit --cov=src/"${PACKAGENAME}" -n auto -v --capture=no; \
	#uv run pytest -m integration --cov=src/"${PACKAGENAME}" -n auto -v --capture=no; \
	#uv run pytest -m security --cov=src/"${PACKAGENAME}" -n auto -v --capture=no; \
	#uv run pytest -m network --cov=src/"${PACKAGENAME}" -n auto -v --capture=no; \
    #coverage run -m pytest -v --capture=no; \
	#coverage report;
########################################################################################

################
# Housekeeping #
################
format_and_lint:
	uv run pre-commit run --all-files --verbose;

bump_version: VERSION
ifeq (${version_repo},"0.0.0")
	@echo "❌ Provide version_repo=X.Y.Z on CLI"
	@echo "Usage: make bump_version version_repo=1.2.3"
else
	@echo "✅ Ensure clean working directory first"
	@if ! git diff-index --quiet HEAD --; then \
		echo "❌ Working directory is dirty. Commit or stash changes first."; \
		exit 1; \
	fi

	@echo "🔄 Pulling latest changes..."
	git pull

	@echo "📝 Bumping repo to version ${version_repo}"
	echo ${version_repo} > VERSION
	sed -i "s/.*__version__.*/__version__ = \"${version_repo}\"/" "src/url_checker_tools/__init__.py"
	sed -i "s/.*version =.*/version = \"${version_repo}\"/" "pyproject.toml"

	@echo "🔒 Updating uv.lock..."
	uv lock

	@echo "📦 Staging changes..."
	git add VERSION
	git add "src/url_checker_tools/__init__.py"
	git add "pyproject.toml"
	git add uv.lock

	@echo "💾 Committing changes..."
	git commit -m "BUMP to version ${version_repo}"

	@echo "🏷️  Creating tag ${version_repo}..."
	git tag ${version_repo} -m "${tag_message}"

	@echo "🚀 Pushing to remote..."
	git push
	git push --tags

	@echo "✅ Version bumped to ${version_repo}"
endif

clean:
	-find . -name __pycache__ -print0 | xargs -0 rm -rf
	-find . -name "*.pyc" -print0 | xargs -0 rm -rf
	-find . -name "*.egg-info" -print0 | xargs -0 rm -rf

coverageclean:
	-rm src/urlchecker/.coverage
	-rm src/urlchecker/.coverage.*
	-rm src/urlchecker/coverage.xml
	-rm -rf src/urlchecker/htmlcov

distclean:
	-rm -rf ./dist
	-rm -rf ./build
	-rm -rf ./venv

venvclean:
	rm -rf $(venv_dir)

nuke: clean distclean testclean venvclean

################
# Makefile Doc #
################
help:
	echo ""
	echo -e "${BLUE}${BOLD}### I am your quick and dirty Help file :) ###${RESET}"
	echo ""
	echo -e "${BOLD}# Run make with targets like:${RESET}"
	echo "make target someparameter=\"somevalue\""
	echo ""
	echo -e "${GREEN}# Available combinations arguments/targets/description:${RESET}"
	echo ""
	echo -e "${BOLD}🛠️  Initialize local dev environment:${RESET}"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "configure_repo_dev" "/" "Configure local Python3 venv + pre-commit hooks"
	echo ""
	echo -e "${BOLD}📦 Development lifecycle:${RESET}"
	@printf "  %-20s %s %-20s %s %s\n" "[target_url="your-url-to-check"]" "/" "run" "/"  "Example run of the CLI tool against url, default to www.google.com"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "malrun_robot" "/"  "Example run of the CLI tool in ROBOT mode against a wicar URL (test)"
	@printf "  %-20s %s %-20s %s %s\n" "[target_url="your-url-to-check"]" "/" "run_robot" "/"  "Run in Robot mode against a parametrised URL"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "test" "/"  "Run test suite"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "format_and_lint" "/"  "Format + lint (pre-commit style)"
	@printf "  %-20s %s %-20s %s %s\n" "[new_package="package-name"]" "/" "add_newdep-dev" "/"  "Just add one new dep in dev mode"
	echo ""
	echo -e "${BOLD}🔥 Build, 🌬️  Publish and 🚀 Release:${RESET}"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "build" "/" "Build locally a .tar.gz for distribution"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "publish" "/" "Publish the build to a Registry (tested with Gitlab on-prem instances)"
	echo ""
	echo -e "${BOLD}🧪 Tests:${RESET}"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "test_units" "/" "Run the test suite (WIP)"
	echo ""
	echo -e "${BOLD}🧹 Housekeeping:${RESET}"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "format_and_lint" "/" "Run the formatter and linter our of pre-commit hooks"
	@printf "  %-20s %s %-20s %s %s\n" "[version_repo=X.Y.Z]" "/" "bump_version" "/" "Bump version + tag (use version_repo=X.Y.Z)"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "clean" "/" "Clean Python artifacts"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "coverageclean" "/" "Clean Coverage test artifacts"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "distclean" "/" "Clean Build and Dist artifacts"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "venvclean" "/" "Clean .venv artifacts"
	@printf "  %-20s %s %-20s %s %s\n" "[none]" "/" "nuke" "/" "Chain the cleaning steps above"
	echo ""
	echo -e "${BOLD}💡 Examples:${RESET}"
	echo "  make configure_repo_dev"
	echo "  make run"
	echo "  make bump_version version_repo=1.2.3 tag_message=\"Release v1.2.3\""
	echo ""
	echo -e "${BOLD}📝 Default arguments that can be superseded on CLI:${RESET}"
	echo "- automatic=\"N\""
	echo "- version_repo=\"0.0.0\""
	echo "-	tag_message=\"\""
	echo "- new_package=\"\""
	echo "- target_url=\"https://www.google.com\""
	echo ""
	echo "To provide API RO Tokens, configure the .env and manage it with care or, better use the key_manager tool to integrate to keychain"
	echo "For publishing to your Registry, configure the .envdev varenvs"
	@printf "\033[0;32m%s\033[0m\n" "Run 'make help' anytime for this reference"

# help:
#	@echo "\033[0;35murl-checker Makefile Help\033[0m"
#	@echo ""
#	@awk '/^[a-zA-Z0-9_-]+:/ { \
#		helpMessage = match(lastLine, /^# (.*)/); \
#		if (helpMessage) { \
#			helpCommand = substr($$1, 0, index($$1, ":")-1); \
#			helpMessage = substr(lastLine, RSTART+2); \
#			print "\033[0;33m", helpCommand "\033[0m", helpMessage; \
#		} \
#	} { lastLine = $$0 }' $(MAKEFILE_LIST)
#