create makefile

Signed-off-by: Chayan Das <[email protected]>

Author: ChayanDass

.github/workflows/actions.yml

@@ -23,6 +23,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
+          cache-dependency-path: Frontend/package-lock.json
 
       - name: Install Dependencies
         run: |
@@ -31,6 +32,7 @@ jobs:
             npm ci
           else
             npm i
+          fi
 
   lint:
     name: Lint

Backend/.gitignore

@@ -32,4 +32,6 @@ licenseRef.json
 
 external_ref_fields.yaml
 
-pkg/models/external_ref_structs.go
+pkg/models/external_ref_structs.go
+coverage.out
+coverage.html

Backend/pkg/models/external_ref_structs.go

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText:  2025 Chayan Das <[email protected]>
+# SPDX-License-Identifier: GPL-2.0-only
+
+
 # Ignore node_modules and build files
 node_modules/
 dist/

Frontend/.dockerignore

@@ -0,0 +1,195 @@
+# SPDX-FileCopyrightText:  2025 Chayan Das <[email protected]>
+# SPDX-License-Identifier: GPL-2.0-only
+
+
+# ==============================================================================
+# Makefile for KubeStellar Backend
+# ==============================================================================
+include Backend/.env
+
+
+
+DB_URL=postgres://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}?sslmode=disable
+MIGRATION_PATH=./Backend/pkg/db/migrations
+
+# Declare all targets as phony (they don't create files with these names)
+.PHONY: help dev build test test-verbose test-coverage test-individual test-file test-func test-watch quick-test fmt lint clean deps create-migration migrate-up migrate-down migrate-force
+
+# Default target - show help
+help:
+	@echo "LicenseDB Backend - Available Commands"
+	@echo "========================================"
+	@echo ""
+	@echo "Development Commands:"
+	@echo "  make generate       - Generate Go structs from external_ref_fields.yaml"
+	@echo "  make build         - Build the Go application"
+	@echo "  make run            - Run backend server (go run)"
+	@echo "  make help          - Display available commands (default target)"
+	@echo ""
+	@echo "Testing Commands:"
+	@echo "  make test          - Run all API tests"
+	@echo "  make test-verbose  - Run tests with verbose output"
+	@echo "  make test-coverage - Run tests with coverage report (generates coverage.html)"
+	@echo "  make test-individual - Run each test file individually"
+	@echo "  make test-file FILE=filename - Run specific test file"
+	@echo "  make test-func FUNC=TestName - Run specific test function"
+	@echo "  make test-watch    - Watch mode info (not implemented - manual alternative)"
+	@echo "  make quick-test    - Run subset of tests (status and logs only)"
+	@echo ""
+	@echo "Code Quality Commands:"
+	@echo "  make fmt           - Format Go code"
+	@echo "  make lint          - Run go vet linter"
+	@echo ""
+	@echo "Utility Commands:"
+	@echo "  make clean         - Clean test cache and temporary files"
+	@echo "  make deps          - Install and tidy Go dependencies"
+	@echo ""
+	@echo "Database Migration Commands:"
+	@echo "  make create-migration     - Create a new database migration file"
+	@echo "  make migrate-up           - Apply all pending database migrations"
+	@echo "  make migrate-down         - Rollback last N database migrations"
+	@echo "  make migrate-force        - Force a specific migration version (e.g., when tables already exist)"
+	@echo "  make migrate-version      - Show the current version of the migration"
+
+# ==============================================================================
+# Development Commands
+# ==============================================================================
+generate:
+	cd Backend
+	@echo "Generating Go structs from external_ref_fields.yaml..."
+	cp Backend/external_ref_fields.example.yaml Backend/external_ref_fields.yaml
+	@echo "Please edit external_ref_fields.yaml as needed..."
+	vim Backend/external_ref_fields.yaml
+	cd Backend && go generate ./...
+	@echo "Struct generation complete"
+
+
+# Build the application
+build:
+	@echo "Building Go application..."
+	cd Backend && go build -o ./lass ./cmd/laas/main.go
+	@echo "Build complete: Backend/lass"
+
+# Run the application
+run:
+	@echo "Running LicenseDB backend..."
+	cd Backend && go run ./cmd/laas/main.go
+	@echo "LicenseDB backend stopped"
+
+# ==============================================================================
+# Testing Commands
+# ==============================================================================
+
+# Run all API tests
+test:
+	@echo "Running all tests..."
+	cd Backend && go test ./... -v
+
+# Run tests with verbose output
+test-verbose:
+	@echo "Running tests with verbose output..."
+	cd Backend && go test ./... -v -count=1
+
+# Run tests with coverage report
+test-coverage:
+	@echo "Running tests with coverage report..."
+	cd Backend && go test ./... -coverprofile=coverage.out
+	cd Backend && go tool cover -html=coverage.out -o coverage.html
+	@echo "Coverage report generated: coverage.html"
+
+# Run each test file individually
+test-individual:
+	@echo "Running each test file individually..."
+	@cd Backend && \
+	for file in $$(find . -name "*_test.go" -not -path "./vendor/*"); do \
+		echo "Testing: $$file"; \
+		go test $$(dirname $$file) -v; \
+	done
+
+
+# Run specific test file
+test-file:
+	@if [ -z "$(FILE)" ]; then \
+		echo "Usage: make test-file FILE=filename"; \
+		echo "Example: make test-file FILE=auth"; \
+	else \
+		echo "Running tests in file: $(FILE)"; \
+		go test ./test/$(FILE) -v; \
+	fi
+
+# Run specific test function
+test-func:
+	@if [ -z "$(FUNC)" ]; then \
+		echo "Usage: make test-func FUNC=TestName"; \
+		echo "Example: make test-func FUNC=TestAuth"; \
+	else \
+		echo "Running test function: $(FUNC)"; \
+		go test ./... -run $(FUNC) -v; \
+	fi
+
+# Watch mode info (manual alternative)
+test-watch:
+	@echo "Test watch mode is not implemented."
+	@echo "Manual alternative: Use 'air' for live reload during development"
+	@echo "Or run: find . -name '*.go' | entr -r go test ./..."
+
+# Run subset of tests (status and logs only)
+quick-test:
+	@echo "Running quick tests (status and logs only)..."
+	@if [ -d "./test/auth" ]; then go test ./test/auth -v; fi
+	@if [ -d "./test/redis" ]; then go test ./test/redis -v; fi
+
+# ==============================================================================
+# Code Quality Commands
+# ==============================================================================
+
+# Format Go code
+fmt:
+	@echo "Formatting Go code..."
+	go fmt ./...
+	@echo "Code formatting complete"
+
+# Run go vet linter
+lint:
+	@echo "Running go vet linter..."
+	go vet ./...
+	@echo "Linting complete"
+
+# ==============================================================================
+# Utility Commands
+# ==============================================================================
+
+# Clean test cache and temporary files
+clean:
+	@echo "Cleaning test cache and temporary files..."
+	go clean -testcache
+	rm -rf bin
+	rm -f coverage.out coverage.html
+	@echo "Cleanup complete"
+
+# Install and tidy Go dependencies
+deps:
+	@echo "Installing and tidying Go dependencies..."
+	go mod download
+	go mod tidy
+	@echo "Dependencies updated"
+
+# Database Migration Commands
+create-migration:
+	@read -p "Enter migration name: " name; \
+	migrate create -ext sql -dir ${MIGRATION_PATH} -seq $${name}
+
+migrate-up:
+	@migrate -path=${MIGRATION_PATH} -database "${DB_URL}" up
+
+migrate-down:
+	@read -p "Number of migrations you want to rollback (default: 1): " NUM; \
+	NUM=$${NUM:-1}; \
+	migrate -path=${MIGRATION_PATH} -database "${DB_URL}" down $${NUM}
+
+migrate-force:
+	@read -p "Enter the version to force: " VERSION; \
+	migrate -path=${MIGRATION_PATH} -database "${DB_URL}" force $${VERSION}
+
+migrate-version:
+	@migrate -path=${MIGRATION_PATH} -database "${DB_URL}" version