Development Environment#
The first task to tackle is setting up the development environment.
Follow the steps below to get an OpenDP development environment set up, including the ability to run tests in both Rust and Python.
Install the Rust toolchain.
Install Python version 3.7 or higher.
Clone the OpenDP Repo#
If you want to submit PRs, but don’t have write access to the OpenDP repository, you will either need to request to join the organization or make a fork. The GitHub documentation explains forking.
Clone the repo (or your fork) and change into the opendp directory that’s created.
git clone git@github.com:opendp/opendp.git
cd opendp
If you have not set up SSH, you can clone with https instead:
git clone https://github.com/opendp/opendp.git
Build OpenDP#
Next, you’ll need to build the Rust binaries.
Make sure you are on the latest Rust version:
rustup update
Now run cargo build in the rust subdirectory of the repo:
cd rust
cargo build --features untrusted,bindings-python
This will compile a debug build of the OpenDP shared library, placing it in the directory opendp/rust/target/debug.
(The specific name of the library file will vary depending on your platform.)
Substitute cargo build with cargo test to test, or cargo check to run a lightweight check that the code is valid.
In the above commands, the features untrusted and bindings-python are enabled.
Setting a feature changes how the crate compiles:
Feature List
Name |
Description |
|---|---|
|
Enables untrusted features |
|
Enable to include constructors that have not passed the vetting process. |
|
Enable to include constructors that are only private if the constructor arguments are honest. |
|
Enable to include transformations/measurements with floating-point vulnerabilities. |
|
Enables the |
|
Enable to include C foreign function interfaces. |
|
Enable to embed links to proofs in the documentation. |
|
Enable to use the system installation of MPFR. |
|
Already enabled. Use MPFR for exact floating-point arithmetic. |
|
Already enabled. Use OpenSSL for secure noise generation. |
To make the crate compile faster, ffi functions in debug builds support a reduced set of primitive types.
Release-mode builds support the full set of primitive types and undergo compiler optimizations, but take longer to compile.
You can compile a release build by adding the --release flag.
In contrast to debug builds, release builds are located in opendp/rust/target/release.
To use a release-mode binary from the Python bindings,
set the environment variable OPENDP_TEST_RELEASE=1 before importing OpenDP.
If you run into problems, please contact us!
Note
You may encounter the following build error on Windows:
error: failed to run custom build command for `gmp-mpfr-sys v1.4.10`
There is a more involved setup guide for Windows users.
You can compromise to simple and vulnerable builds instead, by adding the --no-default-features flag to cargo commands.
Be advised this flag disables GMP’s exact float handling, as well as OpenSSL’s secure noise generation.
Python Setup#
You can install a local Python package that uses your new OpenDP binary.
We recommend setting up a virtual environment first, but this is optional:
Virtual Environment
# recommended. conda is just as valid
python3 -m venv opendp
source opendp/bin/activate
Change to the python directory, install dependencies, and then install the Python OpenDP library itself.
cd python
pip install flake8 pytest wheel
pip install -e .
The -e flag is significant!
It stands for “editable”, meaning you only have to run this command once.
That is, you do not need to reinstall the OpenDP Python package if changes are made in the /python/src folder or to the library binary,
but you should restart the Python interpreter or kernel.
At this point, you should be able import OpenDP as a locally installed package:
import opendp
Note
If you encounter the following error on import:
OSError: dlopen ... (mach-o file, but is an incompatible architecture)
You should check that the architecture from rustc -vV matches your Python architecture.
This can occur if you are on a Mac M1 and have an x86_64 Python install.
Testing Python#
You can test that things are working by running OpenDP’s Python test suite, using pytest.
Run the tests from the python directory.
pytest -v
If everything has gone well, you’ll see a bunch of output, then a line similar to this:
================== 57 passed in 1.02s ==================
If pytest is not found, don’t forget to activate your virtual environment!
This is just a quick overview of building OpenDP. If you’re interested in porting OpenDP to a different platform, we’d be delighted to get your help; please contact us!
Documentation#
The source for this documentation website can be found in the “docs” directory at opendp/opendp. The docs are built using Sphinx and the steps to build it are listed in the README in the “docs” directory.
Developer Tooling#
There are many development environments that work with Rust and LaTex. Here are a few:
Use whatever tooling you are comfortable with.
A few notes on VS Code:
Be sure to install the rust-analyzer plugin, not the Rust plugin
Open
rust-analyzer’s extension settings, search “features” and add"untrusted", "bindings-python"Look for
Problemsin the bottom panel for live compilation errors as you workOther useful extensions are “Better Toml”, “crates” and “LaTex Workshop”
Starter tasks and LaTex Workshop settings:
Expand Me
Starter /.vscode/tasks.json.
These tasks can be used to directly build or test OpenDP.
See also the VSCode documentation on tasks.
{
"version": "2.0.0",
"tasks": [
{
"type": "cargo",
"command": "check",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
]
},
"options": {
"cwd": "./rust"
},
"args": [
"--features",
"untrusted"
],
"group": "build",
"label": "cargo check --features untrusted",
"detail": " gives more detailed compiler errors than problems tab",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "build",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
]
},
"options": {
"cwd": "./rust"
},
"args": [
"--features",
"untrusted bindings-python"
],
"group": "build",
"label": "cargo build --features untrusted,bindings-python",
"detail": " run before testing in Python",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "test",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
]
},
"options": {
"cwd": "./rust"
},
"args": [
"--no-default-features",
"--features",
"bindings-python untrusted"
],
"group": "build",
"label": "cargo test --no-default-features --features untrusted,bindings-python",
"detail": " test a build without GMP/MPFR/OpenSSL (Windows)",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "test",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
]
},
"options": {
"cwd": "./rust"
},
"args": [
"--features",
"bindings-python untrusted"
],
"group": "build",
"label": "cargo test --features untrusted,ffi",
"detail": " run all Rust tests, including ffi",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "clippy",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
],
"source": "clippy"
},
"options": {
"cwd": "./rust"
},
"args": [
"--features",
"bindings-python untrusted"
],
"group": "build",
"label": "cargo clippy --features ffi",
"detail": " more detailed linting and style suggestions",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "rustdoc",
"problemMatcher": {
"base": "$rustc",
"fileLocation": [
"relative",
"${workspaceFolder}/rust"
]
},
"options": {
"cwd": "./rust"
},
"args": [
"--open",
"--features", "derive untrusted",
"--", "--html-in-header", "katex.html", "--document-private-items"
],
"group": "build",
"label": "cargo rustdoc",
"detail": " build rust documentation (and open)",
"presentation": {
"clear": true
}
},
{
"type": "cargo",
"command": "rustdoc",
"problemMatcher": {
"base": "$rustc",
"fileLocation": ["relative", "${workspaceFolder}/rust"],
},
"options": {
"cwd": "./rust"
},
"args": [
"--features", "derive untrusted",
"--", "--html-in-header", "katex.html", "--document-private-items"
],
"group": "build",
"label": "rust: cargo rustdoc",
"presentation": {
"clear": true
}
}
]
}
Starter /.vscode/settings.json.
These settings configure LaTex Workshop to write .pdfs and auxiliary files to ./out/, which is .gitignored.
{
"rust-analyzer.linkedProjects": [
"./rust/Cargo.toml"
],
"rust-analyzer.cargo.extraEnv": {
"OPENDP_SPHINX_PORTx": "8020",
"OPENDP_RUSTDOC_PORTx": "8021"
},
"latex-workshop.latex.outDir": "%DIR%/out/",
"latex-workshop.latex.recipes": [
{
"name": "latexmk",
"tools": [
"latexmk"
]
}
],
"latex-workshop.latex.tools": [
{
"name": "latexmk",
"command": "latexmk",
"args": [
"--synctex=1",
"--interaction=nonstopmode",
"--file-line-error",
"--recorder",
"--pdf",
"--shell-escape",
"--aux-directory=out",
"--output-directory=out",
"%DOC%"
]
},
{
"name": "pdflatex",
"command": "pdflatex",
"args": [
"--synctex=1",
"--interaction=nonstopmode",
"--file-line-error",
"--aux-directory=out",
"--output-directory=out",
"--shell-escape",
"%DOC%"
]
}
],
"latex-workshop.view.pdf.viewer": "tab"
}
A few notes on Intellij IDEA:
Both Intellij IDEA community edition and the CodeWithMe plugin are free
Be sure to open the project at the root of the git repository
Be sure to install the Python and Rust plugins for interactivity
Be sure to “attach” the Cargo.toml in the red banner the first time you open a Rust source file
Use run configurations to build the Rust library and run tests