This repository contains the end-to-end, reliability and performance test cases for the State Space reference implementation of the IAB PrivacyChain Technology Specification. These test cases relate to the State Space services and database manager.
The main body of documentation for the State Space reference implementation of the IAB PrivacyChain Technology Specification can be found with the packaging. The overview and administrative declarations herein are necessarily summary in nature. The declarations and definitions in the packaging area are complete and should be interpreted as superceding these when the two are in conflict.
More detailed information about the scope and purpose of the State Space implementation of the IAB PrivacyChain Reference Design can be found at the following locations:
- State Space
- IAB PrivacyChain Reference Design.
A summary overview is as follows:
- IAB PrivacyChain, contains
- Specification Documents
- Runbooks, Operation Documents
- Project Governance Documents
- Reference Design
- State Space reference implementation of the IAB PrivacyChain Technology Specification
- Packaging, the packaging, the top-level repository.
- Apanolio, a "Northside" API Service, as a macroservice, in Apache HTTPd.
- Montara, a "Northside" API Service, as a microservice.
- Tooling, some operability tooling.
- Testing, some testing and performance assessments.
- PrivacyChain C++, part of the "Southside" service components.
- Hyperledger Fabric C++, part of the "Southside" service components.
- Hyperledger Fabric, the upstream.
- Background
- Dependencies
- Installation
- Configuration
- Build
- Usage
- Security
- Contribute
- Maintainers
- License
This project contains several sorts of tests for the PrivacyChain database manager. These are:
- long-running end-to-end transactional tests
- high-load stress tests
- operability and recoverabilty tests
Not all of these test scenarios are implemented in any of the "oh point" releases; e.g. v0.1.
The configuration step will check for many but not all required packages and operating system features. There is a list of known package-dependencies which you will need to install beyond your base operating system.
Generally, the dependencies are among:
- The Hyperledger Fabric database and its Public Key Infrastructure (PKI) services.
- Various components of the Tunitas system; e.g. the Basic Components.
- A modern C++ development environment, meaning C++20 or C++23, C++2b where available.
- A recent Fedora, e.g., Fedora 35 will suffice but any recent Linux distro should suffice.
The State Space project was developed on Fedora 27 through Fedora 34 using GCC. At this juncture, GCC 12 is preferred, though GCC 11 is the minimum requirement. Because the development started with GCC 7 & GCC 8 using -fconcepts and -std=c++1z, there are still remnants of older compilers and older versions of C++ throughout the code base.. More details on the expected development environment and the build system can be found in temerarious-flagship.
This repo is not independent. It expects to be configured as a submodule of State Space. This should happen naturally in the course of the git submodule activation procedure.
The configuration step will check for many but not all required packages and operating system features. There is a list of known package-dependencies which you will need to install beyond your base operating system.
You may install this repo and its dependents by running the following command:
git clone https://github.com/yahoo/state-space-testing.gitThis will create a directory called state-space-testing and download the contents of this repo to it.
The build system is based upon GNU Autotools.
The configuration of the repo consists of two steps which must be done once.
./buildconf./configure
The first step performs some crude assessments of the build environment and creates the site-specific configure'. Of course configure --helpwill explain the build options. The general options toconfigure` are widely documented.
The buildconf component is boilerplate and can be updated from temerarious-flagship as needed. The Tunitas Build System is expected to be available in /opt/tunitas. There is a template buildconf located at /opt/tunitas/share/temerarious-flagship/bc/template.autotools-buildconf
The simplest configure-compile-install recipe is:
./buildconf &&
./configure &&
make all &&
make check &&
make install &&
echo OK DONEEach individual test case will have a statement of purpose and instructions describing how to run it. Again, a reminder: these are stress tests which populate the database on their own terms. They should be used wisely and on non-production databases (test channels) only. They should not be applied to a production database.
The command line tools produced in the build process each have their own --help options and an associated documentation. These are frequently is maintaned through the use of help2man. For example the tool privacy chain database query tool pct is self-explanatory via pct --help.
full-of-gravel fills the database with random data.
Use full-of-gravel --help
reps-and-sets exercises CRUD in the database with its own data set.
Use reps-and-sets --help
This repo offers testing in support of the State Space reference implementation of the IAB PrivacyChain Technology Specification. As such, this project does not have any direct security concerns. The tools produced by this project provide the means to interact with the PrivacyChain database. For those having access to the database replicas directly, access to these tools will allow individuals to manipulate the database structures directly. Care should be taken to provide such access only to the appropriate operational roles (presenting as persons).
Please refer to the overall Security Notice in the lead repo of the State Space Project.
Please refer to the contribution instructions for information about how to get involved. We welcome issues, questions. Pull Requests are welcome.
Current work with modern-generation tooling, e.g. circa Fedora 36+ and GCC 12+, is occurring around the v0.1-themed feature branches.
- Wendell Baker wbaker@yahooinc.com
- The State Space Team at Yahoo state-space@yahooinc.com
The IAB PrivacyChain Engineering Working Groupis no longer active.
You may contact us at least at state-space@yahooinc.com
This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.