test: add XDR generator snapshot tests. (#767)

Author: overcat

.github/workflows/xdr-generator-snapshot-test.yml

@@ -0,0 +1,22 @@
+name: XDR Generator Snapshot Test
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - "xdr-generator/**"
+      - "Makefile"
+      - ".github/workflows/xdr-generator-snapshot-test.yml"
+  pull_request:
+    paths:
+      - "xdr-generator/**"
+      - "Makefile"
+      - ".github/workflows/xdr-generator-snapshot-test.yml"
+
+jobs:
+  snapshot-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run XDR generator snapshot tests
+        run: make xdr-generator-test

Makefile

@@ -16,7 +16,7 @@ xdr/Stellar-exporter.x
 # stellar-xdr commit to use, see https://github.com/stellar/stellar-xdr
 XDR_COMMIT=4b7a2ef7931ab2ca2499be68d849f38190b443ca
 
-.PHONY: xdr xdr-clean xdr-update
+.PHONY: xdr xdr-clean xdr-update xdr-generator-test xdr-generator-update-snapshots
 
 xdr-generate: $(XDRS)
 	docker run --rm -v $$PWD:/wd -w /wd ruby:3.4 /bin/bash -c '\
@@ -33,3 +33,15 @@ xdr-clean:
 	find src/main/java/org/stellar/sdk/xdr -type f -name "*.java" ! -name "package-info.java" -delete
 
 xdr-update: xdr-clean xdr-generate
+
+xdr-generator-test:
+	docker run --rm -v $$PWD:/wd -w /wd ruby:3.4 /bin/bash -c '\
+		cd xdr-generator && \
+		bundle install --quiet && \
+		bundle exec ruby test/generator_snapshot_test.rb'
+
+xdr-generator-update-snapshots:
+	docker run --rm -v $$PWD:/wd -w /wd ruby:3.4 /bin/bash -c '\
+		cd xdr-generator && \
+		bundle install --quiet && \
+		UPDATE_SNAPSHOTS=1 bundle exec ruby test/generator_snapshot_test.rb'

xdr-generator/Gemfile

@@ -8,3 +8,5 @@ gem "benchmark"
 gem "bigdecimal"
 gem "logger"
 gem "mutex_m"
+
+gem "minitest"

xdr-generator/Gemfile.lock

@@ -48,6 +48,7 @@ DEPENDENCIES
   benchmark
   bigdecimal
   logger
+  minitest
   mutex_m
   xdrgen!
 

xdr-generator/test/fixtures/xdrgen/block_comments.x

@@ -0,0 +1,13 @@
+enum AccountFlags
+{ // masks for each flag
+    AUTH_REQUIRED_FLAG = 0x1
+};
+
+/* AccountEntry
+
+    Main entry representing a user in Stellar. All transactions are performed
+    using an account.
+
+    Other ledger entries created require an account.
+
+*/

xdr-generator/test/fixtures/xdrgen/const.x

@@ -0,0 +1,4 @@
+const FOO = 1;
+
+typedef int TestArray[FOO];
+typedef int TestArray2<FOO>;

xdr-generator/test/fixtures/xdrgen/enum.x

@@ -0,0 +1,42 @@
+enum MessageType
+{
+    ERROR_MSG,
+    HELLO,
+    DONT_HAVE,
+
+    GET_PEERS,   // gets a list of peers this guy knows about
+    PEERS,
+
+    GET_TX_SET,  // gets a particular txset by hash
+    TX_SET,
+
+    GET_VALIDATIONS, // gets validations for a given ledger hash
+    VALIDATIONS,
+
+    TRANSACTION, //pass on a tx you have heard about
+    JSON_TRANSACTION,
+
+    // FBA
+    GET_FBA_QUORUMSET,
+    FBA_QUORUMSET,
+    FBA_MESSAGE
+};
+
+enum Color {
+    RED=0,
+    GREEN=1,
+    BLUE=2
+};
+
+
+enum Color2 {
+    RED2=RED,
+    GREEN2=1,
+    BLUE2=2
+};
+
+enum Color3 {
+    RED_1=1,
+    RED_2_TWO=2,
+    RED_3=3
+};

xdr-generator/test/fixtures/xdrgen/nesting.x

@@ -0,0 +1,24 @@
+enum UnionKey {
+  ONE = 1,
+  TWO = 2,
+  OFFER = 3
+};
+
+typedef int Foo;
+
+union MyUnion switch (UnionKey type)
+{
+    case ONE:
+        struct {
+            int someInt;
+        } one;
+
+    case TWO:
+        struct {
+            int someInt;
+            Foo foo;
+        } two;
+
+    case OFFER:
+        void;
+};

xdr-generator/test/fixtures/xdrgen/optional.x

@@ -0,0 +1,8 @@
+typedef int Arr[2];
+
+struct HasOptions
+{
+  int* firstOption;
+  int *secondOption;
+  Arr *thirdOption;
+};

xdr-generator/test/fixtures/xdrgen/struct.x

@@ -0,0 +1,10 @@
+typedef hyper int64;
+
+struct MyStruct
+{
+    int    someInt;
+    int64  aBigInt;
+    opaque someOpaque[10];
+    string someString<>;
+    string maxString<100>;
+};