Merge pull request #2 from pquerna/pq/iterate

[WIP] Iteration to get functional protobuf generation

Author: valllabh

.dockerignore

@@ -0,0 +1 @@
+/build

.gitignore

@@ -1,3 +1,5 @@
+/build
+
 # If you prefer the allow list template instead of the deny list, see community template:
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #
@@ -21,14 +23,3 @@
 go.work
 
 
-## Project
-# Ignore ocsf-tool directory
-ocsf-tool
-
-# Ignore schema directory
-schema
-
-# Ignore proto directory
-proto
-
-schema.json

Makefile

@@ -1,61 +1,22 @@
+.PHONY: build
+build:
 
-# prepare system for build
-prepare:
-	@echo "Preparing system for build..."
+PROTOC_IMAGE=ocsf-schema-golang-protoc
+PROTOC_VERSION=0.1.2
 
-	sudo apt-get update
+protocontainer:
+	docker build --load -t $(PROTOC_IMAGE):$(PROTOC_VERSION) -f dev/protoc/protoc.Dockerfile dev/protoc/
 
-	# install protobuf-compiler
-	sudo apt-get install -y protobuf-compiler
-	export PATH="$PATH:$(go env GOPATH)/bin"
-	go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
-	protoc --version
+generate-proto: protocontainer
+	docker run --rm \
+	--mount type=bind,source="$(PWD)",target=/build \
+	$(PROTOC_IMAGE):$(PROTOC_VERSION) \
+	generate-proto.sh
 
-	# install jq
-	sudo apt-get install -y jq
+generate-go: protocontainer
+	docker run --rm \
+	--mount type=bind,source="$(PWD)",target=/build \
+	$(PROTOC_IMAGE):$(PROTOC_VERSION) \
+	generate-go.sh
 
-	# install ocsf-tool
-	make install-ocsf-tool
-
-	# install buf
-	make install-buf
-
-	@echo "System is ready for build."
-
-# install homebrew
-install-homebrew:
-	@echo "Installing homebrew..."
-	curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh | bash
-
-install-buf: install-homebrew
-	@echo "Installing buf..."
-	/home/linuxbrew/.linuxbrew/bin/brew install bufbuild/buf/buf
-
-# install ocsf-tool
-install-ocsf-tool:
-	@echo "Installing latest version of ocsf-tool..."
-	curl -sfL https://raw.githubusercontent.com/valllabh/ocsf-tool/main/download/download.sh | bash
-
-create-proto-files:
-	@echo "Getting event list..."
-	./ocsf-tool/ocsf-tool schema-class-list --output ./schema/schema-class-list.json
-
-	@echo "Creating proto files..."
-	jq -r "[.[] | to_entries[] | .value] | join(\" \")" ./schema/schema-class-list.json | xargs ./ocsf-tool/ocsf-tool generate-proto --golang-root-package / --proto-output ./proto
-
-compile-proto: clean-output
-	@echo "Compiling proto files..."
-	/home/linuxbrew/.linuxbrew/bin/buf generate
-	
-	@echo "Preparing Enum Value Map..."
-	bash ./enum-value/enum-value-map.sh
-
-clean-output:
-	@echo "Cleaning output directory..."
-	rm -rf ./ocsf
-
-generate-documentation:
-	gomarkdoc ./ >> docs.md
-
-build: create-proto-files compile-proto
-	@echo "Building Finished."
+generate: generate-proto generate-go

build/.keep

@@ -1,3 +1,4 @@
+---
 extensions:
     discovery:
         paths: # no external extensions required
@@ -11,7 +12,7 @@ schema:
                 branch:
                     name: v1.0.0
                 directory:
-                    path: $CWD/schema/git
+                    path: $CWD/build/schema-git
                 url: https://github.com/ocsf/ocsf-schema
         strategy: repository
-    path: $CWD/schema
+    path: $CWD/schema

config.yaml renamed to dev/protoc/config-v1.0.yaml

@@ -0,0 +1,18 @@
+---
+extensions:
+    discovery:
+        paths: # no external extensions required
+    selected: [] # blank to load all default extensions
+profiles:
+    selected: [] # blank to load all default profiles
+schema:
+    loading:
+        strategies:
+            repository:
+                branch:
+                    name: v1.1.0
+                directory:
+                    path: $CWD/build/schema-git
+                url: https://github.com/ocsf/ocsf-schema
+        strategy: repository
+    path: $CWD/schema

dev/protoc/config-v1.1.yaml

@@ -0,0 +1,18 @@
+---
+extensions:
+    discovery:
+        paths: # no external extensions required
+    selected: [] # blank to load all default extensions
+profiles:
+    selected: [] # blank to load all default profiles
+schema:
+    loading:
+        strategies:
+            repository:
+                branch:
+                    name: v1.2.0
+                directory:
+                    path: $CWD/build/schema-git
+                url: https://github.com/ocsf/ocsf-schema
+        strategy: repository
+    path: $CWD/schema

dev/protoc/config-v1.2.yaml

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec /usr/local/bin/buf generate

dev/protoc/generate-go.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -euxo pipefail
+
+verions=("v1.0" "v1.1" "v1.2")
+for i in "${verions[@]}"
+do
+    config_file="/configs/config-${i}.yaml"
+    echo "${i}: Getting event list..."
+    ocsf-tool schema-class-list --config "${config_file}" --output "./schema/tmp.json"
+
+    jq . "./schema/tmp.json" > "./schema/${i}-schema-class-list.json"
+    rm -f ./schema/tmp.json
+
+    echo "${i}: Creating proto files..."
+    jq -r "[.[] | to_entries[] | .value] | join(\" \")" "./schema/${i}-schema-class-list.json" | xargs ocsf-tool generate-proto --config "${config_file}"  --golang-root-package / --proto-output ./proto
+
+    jq . schema.json > "schema/${i}-schema.json"
+    rm -f schema.json
+    echo "${i}: done"
+done
+

dev/protoc/generate-proto.sh

@@ -0,0 +1,49 @@
+FROM golang:1.22-bookworm as build
+
+FROM build as build-go
+# https://github.com/protocolbuffers/protobuf-go/releases
+ARG PROTOC_GEN_GO_VERSION=1.34.1
+ARG PROTOC_GEN_GO_HASH="8aff9ec0c28a926daeedb1ce1f87a284e22fc5a892e9e5f7c850881137c85000"
+
+
+RUN mkdir /xsrc && cd /xsrc && \
+    curl -fLO https://github.com/protocolbuffers/protobuf-go/archive/refs/tags/v${PROTOC_GEN_GO_VERSION}.tar.gz && \
+    echo "${PROTOC_GEN_GO_HASH} v${PROTOC_GEN_GO_VERSION}.tar.gz" | sha256sum -c - && \
+    tar -xzf v${PROTOC_GEN_GO_VERSION}.tar.gz && \
+    cd protobuf-go-${PROTOC_GEN_GO_VERSION}/cmd/protoc-gen-go && \
+    go install -v . && \
+    cd / && \
+    rm -rf "/xsrc"
+
+FROM build as build-ocsf-tool
+
+ARG OCSF_TOOL_REPO=https://github.com/pquerna/ocsf-tool.git
+ARG OCSF_TOOL_COMMIT=ac25244eef1d5843933a670dc0c3ce181b3faafe
+
+RUN mkdir /xsrc && cd /xsrc && \
+    git clone ${OCSF_TOOL_REPO} && \
+    cd ocsf-tool && \
+    git checkout ${OCSF_TOOL_COMMIT} && \
+    go install -v . && \
+    cd / && \
+    rm -rf "/xsrc"
+
+# https://github.com/bufbuild/buf/releases
+FROM bufbuild/buf:1.31.0 as buf
+
+FROM debian:bookworm as final
+
+RUN mkdir /build && apt-get -y update && apt-get -y install \
+    protobuf-compiler \
+    jq \
+    ca-certificates \
+    rsync
+
+COPY --from=buf /usr/local/bin/buf /usr/local/bin
+COPY --from=build-go /go/bin/protoc-gen-go /usr/local/bin
+COPY --from=build-ocsf-tool /go/bin/ocsf-tool /usr/local/bin
+COPY ./generate-proto.sh /usr/local/bin/generate-proto.sh
+COPY ./generate-go.sh /usr/local/bin/generate-go.sh
+COPY ./config-v*.yaml /configs/
+
+WORKDIR /build