Run oracle program C tests from Rust (#349)

* link c tests to rust

* cleanup

* ok

* cleanup

* pr comments

Author: jayantk

README.md

@@ -1,5 +1,45 @@
 # pyth-client
-client API for on-chain pyth programs
+
+Pyth oracle program and off-chain client API.
+
+## Oracle Program
+
+The Pyth oracle program lives in the `program/` directory.
+It consists of both C and Rust code, but everything can be built and tested using `cargo`.
+
+### Build Instructions
+
+First, make sure you have the [solana tool suite](https://docs.solana.com/cli/install-solana-cli-tools#use-solanas-install-tool)
+installed on your machine. (The build depends on some C makefiles that are in the tool suite.)
+
+Then, simply run `cargo build` to compile the oracle program as a native binary, or `cargo build-bpf` to build a BPF binary 
+that can be uploaded to the blockchain. This step will produce a program binary `target/deploy/pyth_oracle.so`.
+
+### Testing
+
+Simply run `cargo test`. This command will run several sets of tests:  
+
+- Unit tests of individual functions 
+- Simulated transaction tests against the BPF binary running on a solana simulator
+- Exhaustive / randomized test batteries for core oracle functionality
+
+Rust tests live in the `tests/` module of the rust code, and C tests are named something like `test_*.c`.
+The C tests are linked into the rust binary so they run as part of `cargo test` as well (see `tests/test_c_code.rs`).
+
+You can also run `cargo test-bpf`, which runs the same tests as `cargo test`, though it's slightly slower and the UX is worse.
+
+### pre-commit hooks
+pre-commit is a tool that checks and fixes simple issues (formatting, ...) before each commit. You can install it by following [their website](https://pre-commit.com/). In order to enable checks for this repo run `pre-commit install` from command-line in the root of this repo.
+
+The checks are also performed in the CI to ensure the code follows consistent formatting. Formatting is only currently enforced in the `program/` directory.
+You might also need to install the nightly toolchain to run the formatting by running `rustup toolchain install nightly`.
+
+## pythd (off-chain client API)
+
+> :warning: pythd is deprecated and has been replaced by [pyth-agent](https://github.com/pyth-network/pyth-agent).
+> This new client is backward compatible with pythd, but more stable and configurable. 
+
+`pythd` provides exposes a web API for interacting with the on-chain oracle program.
 
 ### Build Instructions
 
@@ -44,30 +84,6 @@ This command runs a recent pyth-client docker image that already has the necessa
 Therefore, once the container is running, all you have to do is run `cd pyth-client && ./scripts/build.sh`.
 Note that updates to the `pyth-client` directory made inside the docker container will be persisted to the host filesystem (which is probably desirable).
 
-### Local development
-
-First, make sure you're building on the x86_64 architecture.
-On a mac, this command will switch your shell to x86_64:
-
-`env /usr/bin/arch -x86_64 /bin/bash --login`
-
-then in the `program/c` directory, run:
-
-```
-make
-make cpyth-bpf
-make cpyth-native
-```
-
-then in the `program/rust` directory, run:
-
-```
-cargo build-bpf
-cargo test
-```
-
-Note that the tests depend on the bpf build!
-
 ### Fuzzing
 
 Build a docker image for running fuzz tests:
@@ -130,8 +146,3 @@ root@pyth-dev# usermod -u 1002 -g 1004 -s /bin/bash pyth
 
 Finally, in docker extension inside VS Code click right and choose "Attach VS Code". If you're using a remote host in VS Code make sure to let this connection be open.
 
-### pre-commit hooks
-pre-commit is a tool that checks and fixes simple issues (formatting, ...) before each commit. You can install it by following [their website](https://pre-commit.com/). In order to enable checks for this repo run `pre-commit install` from command-line in the root of this repo.
-
-The checks are also performed in the CI to ensure the code follows consistent formatting. Formatting is only currently enforced in the `program/` directory.
-You might also need to install the nightly toolchain to run the formatting by running `rustup toolchain install nightly`.

docker/Dockerfile

@@ -63,8 +63,6 @@ RUN ./pyth-client/scripts/patch-solana.sh
 # Build and test the oracle program.
 RUN cd pyth-client && ./scripts/build-bpf.sh .
 RUN cd pyth-client && ./scripts/check-size.sh
-# Run aggregation logic tests
-RUN cd pyth-client && ./scripts/run-aggregation-tests.sh
 RUN cd pyth-client/pyth && poetry install && poetry run python -m pytest
 
 ENTRYPOINT []

program/c/makefile

@@ -16,7 +16,7 @@ endif
 # The all target is defined by the solana makefile included above and generates the needed .o file.
 .PHONY: cpyth-bpf
 cpyth-bpf: all
-	bash -c "ar rcs $(OUT_DIR)/libcpyth-bpf.a $(OUT_DIR)/**/*.o"
+	bash -c "ar rcs $(OUT_DIR)/libcpyth-bpf.a $(OUT_DIR)/oracle/*.o"
 
 
 # 2-Stage Contract Build
@@ -27,3 +27,18 @@ cpyth-bpf: all
 cpyth-native:
 	gcc -c ./src/oracle/native/upd_aggregate.c -o $(OUT_DIR)/cpyth-native.o -fPIC
 	ar rcs $(OUT_DIR)/libcpyth-native.a $(OUT_DIR)/cpyth-native.o
+
+
+# Note: there's probably a smart way to do this with wildcards but I (jayant) can't figure it out
+.PHONY: test
+test:
+	mkdir -p $(OUT_DIR)/test/
+	gcc -c ./src/oracle/model/test_price_model.c -o $(OUT_DIR)/test/test_price_model.o -fPIC
+	gcc -c ./src/oracle/sort/test_sort_stable.c -o $(OUT_DIR)/test/test_sort_stable.o -fPIC
+	gcc -c ./src/oracle/util/test_align.c -o $(OUT_DIR)/test/test_align.o -fPIC
+	gcc -c ./src/oracle/util/test_avg.c -o $(OUT_DIR)/test/test_avg.o -fPIC
+	gcc -c ./src/oracle/util/test_hash.c -o $(OUT_DIR)/test/test_hash.o -fPIC
+	gcc -c ./src/oracle/util/test_prng.c -o $(OUT_DIR)/test/test_prng.o -fPIC
+	gcc -c ./src/oracle/util/test_round.c -o $(OUT_DIR)/test/test_round.o -fPIC
+	gcc -c ./src/oracle/util/test_sar.c -o $(OUT_DIR)/test/test_sar.o -fPIC
+	ar rcs $(OUT_DIR)/libcpyth-test.a $(OUT_DIR)/test/*.o

program/c/src/oracle/model/clean

@@ -14,10 +14,7 @@ qcmp( void const * _p,
   return 0;
 }
 
-int
-main( int     argc,
-      char ** argv ) {
-  (void)argc; (void)argv;
+int test_price_model() {
 
   prng_t _prng[1];
   prng_t * prng = prng_join( prng_new( _prng, (uint32_t)0, (uint64_t)0 ) );
@@ -29,10 +26,7 @@ main( int     argc,
   int64_t val    [3];
   int64_t scratch[N];
 
-  int ctr = 0;
   for( int iter=0; iter<10000000; iter++ ) {
-    if( !ctr ) { printf( "Completed %u iterations\n", iter ); ctr = 100000; }
-    ctr--;
 
     /* Generate a random test */
 
@@ -63,6 +57,5 @@ main( int     argc,
 
   prng_delete( prng_leave( prng ) );
 
-  printf( "pass\n" );
   return 0;
 }

program/c/src/oracle/model/run_tests

@@ -9,10 +9,7 @@
 #define SORT_BEFORE(i,j) BEFORE(i,j)
 #include "tmpl/sort_stable.c"
 
-int
-main( int     argc,
-      char ** argv ) {
-  (void)argc; (void)argv;
+int test_sort_stable() {
 
 # define N 96
   int x[N];
@@ -23,7 +20,6 @@ main( int     argc,
      additional information in the keys to validate stability as well). */
 
   for( int n=0; n<=24; n++ ) {
-    printf( "Zero-One: Testing n=%i\n", n );
     for( long b=0L; b<(1L<<n); b++ ) {
       for( int i=0; i<n; i++ ) x[i] = (((int)((b>>i) & 1L))<<16) | i;
       for( int i=0; i<n; i++ ) w[i] = x[i];
@@ -49,10 +45,7 @@ main( int     argc,
   prng_t _prng[1];
   prng_t * prng = prng_join( prng_new( _prng, (uint32_t)0, (uint64_t)0 ) );
 
-  int ctr = 0;
   for( int iter=0; iter<10000000; iter++ ) {
-    if( !ctr ) { printf( "Randomized: Completed %i iterations\n", iter ); ctr = 100000; }
-    ctr--;
 
     int n = (int)(prng_uint32( prng ) % (uint32_t)(N+1)); /* In [0,N], approx uniform IID */
     for( int i=0; i<n; i++ ) x[i] = (int)((prng_uint32( prng ) & UINT32_C( 0x00ff0000 )) | (uint32_t)i);
@@ -74,8 +67,6 @@ main( int     argc,
   }
 
   prng_delete( prng_leave( prng ) );
-
-  printf( "pass\n" );
   return 0;
 }