oscal-server/Makefile at main · metaschema-framework/oscal-server · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# Makefile for OSCAL Server Release Assembly

# Default variables for OSCAL repository
OSCAL_REPO ?= https://github.com/usnistgov/OSCAL.git
OSCAL_VERSION ?= main

# Default target
.PHONY: all
all: init-submodules clean-deps build-metaschema build-liboscal build-client compile package

# Clean specific dependencies from Maven repository
.PHONY: clean-deps
clean-deps:
	@echo "Cleaning dependencies from Maven repository..."
	rm -rf $(HOME)/.m2/repository/dev/metaschema

# Initialize and update all submodules (including nested ones)
.PHONY: init-submodules
init-submodules:
	@echo "Initializing and updating all submodules..."
	git submodule update --init --recursive
	cd lib/liboscal-java && git submodule update --init --recursive
	cd lib/metaschema-java && git submodule update --init --recursive
	cd client && git submodule update --init --recursive


# Build and install metaschema-java (must be built first)
.PHONY: build-metaschema
build-metaschema:
	@echo "Building and installing metaschema-java..."
	cd lib/metaschema-java/ && \
	mvn -B -e -Prelease -Psnapshots install -Dsk -DskipTests

# Build and install liboscal-java (depends on metaschema-java)
.PHONY: build-liboscal
build-liboscal:
	@echo "Building and installing liboscal-java with OSCAL repo: $(OSCAL_REPO) and version: $(OSCAL_VERSION)..."
	cd lib/liboscal-java && \
	git submodule deinit -f oscal && \
	git rm -f oscal && \
	git submodule add $(OSCAL_REPO) oscal && \
	cd oscal && \
	git fetch && \
	git checkout $(OSCAL_VERSION) && \
	cd .. && \
	mvn -B -e -Prelease -Psnapshots install -DskipTests

# Clean the main project
.PHONY: clean
clean:
	@echo "Cleaning the main project..."
	mvn clean

# Build the client
.PHONY: build-client
build-client:
	@echo "Building the client..."
	cd client && npm ci && npm run build && cd ..
	@echo "Copying client build to webroot..."
	cp -r client/public/* src/main/resources/webroot

# Compile the main project with the correct versions
.PHONY: compile
compile:
	@echo "Compiling the main project..."
	# Always build the dependencies first to ensure they're available
	make build-metaschema
	make build-liboscal
	mvn compile

# Package the main project with the correct versions
.PHONY: package
package:
	@echo "Packaging the main project..."
	# Always build the dependencies first to ensure they're available
	make build-metaschema
	make build-liboscal
	make build-client
	mvn package

# Run unit tests
.PHONY: test
test:
	@echo "Running unit tests..."
	# Always build the dependencies first to ensure they're available
	make build-metaschema
	make build-liboscal
	make build-client
	mvn test

# Create a release (for testing purposes)
.PHONY: create-release
create-release:
	@echo "Creating a test release..."
	# Always build the dependencies first to ensure they're available
	make build-metaschema
	make build-liboscal
	make build-client
	VERSION=$$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout) && \
	echo "Project version: $$VERSION" && \
	echo "Release artifact: ./target/server-$$VERSION-oscal-server.zip"

# Help target
.PHONY: help
help:
	@echo "OSCAL Server Release Assembly Makefile"
	@echo ""
	@echo "Available targets:"
	@echo "  all               - Run the complete build process (default)"
	@echo "  init-submodules   - Initialize and update all submodules"
	@echo "  build-liboscal    - Build and install liboscal-java"
	@echo "  build-metaschema  - Build and install metaschema-java"
	@echo "  clean             - Clean the main project"
	@echo "  build-client      - Build the client"
	@echo "  compile           - Compile the main project"
	@echo "  package           - Package the main project"
	@echo "  test              - Run unit tests"
	@echo "  create-release    - Create a test release"
	@echo "  help              - Show this help message"
	@echo ""
	@echo "Parameters:"
	@echo "  OSCAL_REPO        - Git repository URL for OSCAL (default: https://github.com/usnistgov/OSCAL.git)"
	@echo "  OSCAL_VERSION     - Git branch, tag, or commit hash for OSCAL (default: main)"
	@echo ""
	@echo "Usage examples:"
	@echo "  make                                                  - Run the complete build process with default OSCAL version"
	@echo "  make OSCAL_VERSION=v1.1.0                            - Run with OSCAL v1.1.0"
	@echo "  make OSCAL_REPO=https://github.com/fork/OSCAL.git OSCAL_VERSION=feature-branch - Run with custom repo and branch"
	@echo "  make help                                             - Show this help message"