Switch to a workspace based project architecture

uael · hchataing · commit 03f000803ee5 · 2023-08-25T09:16:05.000-07:00
This complete the migration to a workspace based project architecture.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -86,10 +86,10 @@ jobs:
           python3 -m pip install typing_extensions
 
       - name: Install pdlc
-        run: cargo install --path .
+        run: cargo install --path pdl-compiler/
 
       - name: Run CXX generator tests
-        run: tests/run_cxx_generator_tests.sh
+        run: pdl-compiler/tests/run_cxx_generator_tests.sh
 
       - name: Run Python generator tests
-        run: tests/run_python_generator_tests.sh
+        run: pdl-compiler/tests/run_python_generator_tests.sh
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 Cargo.lock
-scripts/pdl/__pycache__/
+**/__pycache__/
+out/
 target/
+venv/
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,4 @@
+[workspace]
+members = [
+    "pdl-compiler",
+]
diff --git a/doc/cxx-generated-code-guide.rst b/doc/cxx-generated-code-guide.rst
@@ -24,7 +24,7 @@ Example invocation:
 .. sourcecode:: bash
 
     cargo run my-protocol.pdl --output-format json | \
-        ./scripts/generate_cxx_backend.py > my-protocol.h
+        ./pdl-compiler/scripts/generate_cxx_backend.py > my-protocol.h
 
 Language bindings
 -----------------
diff --git a/doc/python-generated-code-guide.rst b/doc/python-generated-code-guide.rst
@@ -20,7 +20,7 @@ Example invocation:
 .. sourcecode:: bash
 
     cargo run my-protocol.pdl --output-format json | \
-        ./scripts/generate_python_backend.py > my-protocol.py
+        ./pdl-compiler/scripts/generate_python_backend.py > my-protocol.py
 
 Language bindings
 -----------------
diff --git a/fuzz/.gitignore b/fuzz/.gitignore
diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
@@ -11,7 +11,7 @@ cargo-fuzz = true
 libfuzzer-sys = "0.4"
 
 [dependencies.pdl-compiler]
-path = ".."
+path = "../pdl-compiler"
 
 # Prevent this from interfering with workspaces
 [workspace]
diff --git a/fuzz/fuzz_targets/backends_json_generate.rs b/fuzz/fuzz_targets/backends_json_generate.rs
diff --git a/fuzz/fuzz_targets/backends_rust_generate.rs b/fuzz/fuzz_targets/backends_rust_generate.rs
diff --git a/pdl-compiler/Cargo.toml b/pdl-compiler/Cargo.toml
@@ -5,23 +5,21 @@ edition = "2021"
 description = "Parser and serializer generator for protocol binary packets"
 repository = "https://github.com/google/pdl/"
 license = "Apache-2.0"
-readme = "README.md"
+readme = "../README.md"
 keywords = ["pdl", "parser", "serializer", "grammar"]
 authors = [
     "Henri Chataing <henrichataing@google.com>",
     "David de Jesus Duarte <licorne@google.com>",
     "Martin Geisler <mgeisler@google.com>"
 ]
-exclude = [".github/*", "editors/*"]
+exclude = ["editors/*"]
 categories = ["parsing"]
 default-run = "pdlc"
 
 [[bin]]
 name = "pdlc"
 path = "src/main.rs"
 
-[workspace]
-
 [features]
 default = ["serde"]
 
diff --git a/pdl-compiler/tests/run_cxx_generator_tests.sh b/pdl-compiler/tests/run_cxx_generator_tests.sh
@@ -3,44 +3,48 @@
 set -euxo pipefail
 
 mkdir -p out/
+OUT_DIR="$(pwd)/out"
+
+# move to `pdl-compiler` directory
+cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." &> /dev/null
 
 sed -e 's/little_endian_packets/big_endian_packets/' \
     -e '/Start: little_endian_only/,/End: little_endian_only/d' \
-    < tests/canonical/le_test_file.pdl > out/be_test_file.pdl
+    < tests/canonical/le_test_file.pdl > "$OUT_DIR"/be_test_file.pdl
 
-pdlc tests/canonical/le_test_file.pdl > out/le_test_file.json
-pdlc out/be_test_file.pdl > out/be_test_file.json
+pdlc tests/canonical/le_test_file.pdl > "$OUT_DIR"/le_test_file.json
+pdlc "$OUT_DIR"/be_test_file.pdl > "$OUT_DIR"/be_test_file.json
 
 python3 scripts/generate_cxx_backend.py \
-    --input out/le_test_file.json \
-    --output out/le_backend.h \
+    --input "$OUT_DIR"/le_test_file.json \
+    --output "$OUT_DIR"/le_backend.h \
     --namespace le_backend
 python3 scripts/generate_cxx_backend.py \
-    --input out/be_test_file.json \
-    --output out/be_backend.h \
+    --input "$OUT_DIR"/be_test_file.json \
+    --output "$OUT_DIR"/be_backend.h \
     --namespace be_backend
 
 python3 scripts/generate_cxx_backend_tests.py \
-    --input out/le_test_file.json \
-    --output out/le_backend_tests.cc \
+    --input "$OUT_DIR"/le_test_file.json \
+    --output "$OUT_DIR"/le_backend_tests.cc \
     --test-vectors tests/canonical/le_test_vectors.json \
     --namespace le_backend \
     --parser-test-suite le_backend_parser_test \
     --serializer-test-suite le_backend_serializer_test \
     --include-header le_backend.h
 python3 scripts/generate_cxx_backend_tests.py \
-    --input out/be_test_file.json \
-    --output out/be_backend_tests.cc \
+    --input "$OUT_DIR"/be_test_file.json \
+    --output "$OUT_DIR"/be_backend_tests.cc \
     --test-vectors tests/canonical/be_test_vectors.json \
     --namespace be_backend \
     --parser-test-suite be_backend_parser_test \
     --serializer-test-suite be_backend_serializer_test \
     --include-header be_backend.h
 
-g++ -Iscripts -Iout \
-    out/le_backend_tests.cc \
-    out/be_backend_tests.cc \
-    -lgtest -lgtest_main -o out/cxx_backend_tests
+g++ -Iscripts -I"$OUT_DIR" \
+    "$OUT_DIR"/le_backend_tests.cc \
+    "$OUT_DIR"/be_backend_tests.cc \
+    -lgtest -lgtest_main -o "$OUT_DIR"/cxx_backend_tests
 
-./out/cxx_backend_tests \
-    --gtest_output="xml:out/cxx_backend_tests_detail.xml"
+"$OUT_DIR"/cxx_backend_tests \
+    --gtest_output="xml:$OUT_DIR/cxx_backend_tests_detail.xml"
diff --git a/pdl-compiler/tests/run_python_generator_tests.sh b/pdl-compiler/tests/run_python_generator_tests.sh
@@ -3,22 +3,26 @@
 set -euxo pipefail
 
 mkdir -p out/
+OUT_DIR="$(pwd)/out"
+
+# move to `pdl-compiler` directory
+cd -- "$(dirname -- "${BASH_SOURCE[0]}")/.." &> /dev/null
 
 sed -e 's/little_endian_packets/big_endian_packets/' \
     -e '/Start: little_endian_only/,/End: little_endian_only/d' \
-    < tests/canonical/le_test_file.pdl > out/be_test_file.pdl
+    < tests/canonical/le_test_file.pdl > "$OUT_DIR"/be_test_file.pdl
 
-pdlc tests/canonical/le_test_file.pdl > out/le_test_file.json
-pdlc out/be_test_file.pdl > out/be_test_file.json
+pdlc tests/canonical/le_test_file.pdl > "$OUT_DIR"/le_test_file.json
+pdlc "$OUT_DIR"/be_test_file.pdl > "$OUT_DIR"/be_test_file.json
 
 python3 scripts/generate_python_backend.py \
-    --input out/le_test_file.json \
-    --output out/le_backend.py \
+    --input "$OUT_DIR"/le_test_file.json \
+    --output "$OUT_DIR"/le_backend.py \
     --custom-type-location tests.custom_types
 python3 scripts/generate_python_backend.py \
-    --input out/be_test_file.json \
-    --output out/be_backend.py \
+    --input "$OUT_DIR"/be_test_file.json \
+    --output "$OUT_DIR"/be_backend.py \
     --custom-type-location tests.custom_types
 
-export PYTHONPATH="./out:.:${PYTHONPATH:-}"
+export PYTHONPATH="$OUT_DIR:.:${PYTHONPATH:-}"
 python3 tests/python_generator_test.py
