# state-space-testing

**Repository Path**: mirrors_yahoo/state-space-testing

## Basic Information

- **Project Name**: state-space-testing
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# State Space, Testing

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](https://github.com/yahoo/state-space-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](https://github.com/yahoo/state-space)
* [IAB PrivacyChain](https://github.com/InteractiveAdvertisingBureau/PrivacyChain/blob/master/README.md) Reference Design.

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

A summary overview is as follows:
* IAB [PrivacyChain](https://github.com/InteractiveAdvertisingBureau/PrivacyChain), contains
    * Specification Documents
    * Runbooks, Operation Documents
    * Project Governance Documents
    * Reference Design
* State Space reference implementation of the IAB PrivacyChain Technology Specification
    * [Packaging](https://github.com/yahoo/state-space-packaging), the packaging, the top-level repository.
    * [Apanolio](https://github.com/yahoo/tunitas-apanolio), a "Northside" API Service, as a macroservice, in [Apache HTTPd](https://httpd.apache.org/).
    * [Montara](https://github.com/yahoo/tunitas-montara), a "Northside" API Service, as a microservice.
    * [Tooling](https://github.com/yahoo/state-space-tooling), some operability tooling.
    * [Testing](https://github.com/yahoo/state-space-testing), some testing and performance assessments.
    * [PrivacyChain C++](https://github.com/yahoo/PrivacyChain-sdk-cxx), part of the "Southside" service components.
    * [Hyperledger Fabric C++](https://github.com/yahoo/hyperledger-fabric-sdk-cxx), part of the "Southside" service components.
* [Hyperledger Fabric](https://github.com/hyperledger/fabric), the upstream.

## Table of Contents

- [Background](#background)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Configuration](#configuration)
- [Build](#build)
- [Usage](#usage)
- [Security](#security)
- [Contribute](#contribute)
- [Maintainers](#maintainers)
- [License](#license)

## Background

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; <em>e.g.</em> v0.1.

## Dependencies

The [configuration](#configuration) step will check for many but not all required packages and operating system features.  There is a list of known [package-dependencies](https://github.com/yahoo/state-space-testing/blob/master/PACKAGES.md) 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; <em>e.g.</em> the [Basic Components](https://github.com/yahoo/tunitas-basic).
- A modern C++ development environment, meaning C++20 or C++23, C++2b where available.
- A recent Fedora, <em>e.g.</em>, 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 &amp; 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](https://github.com/yahoo/temerarious-flagship/blob/master/README.md).

## Installation

This repo is not independent. It expects to be configured as a submodule of [State Space](https://github.com/yahoo/state-space).  This should happen naturally in the course of the git submodule activation procedure. <!-- remove the need for git submodules ... prefer the use of nearby worktrees -->

The [configuration](#configuration) step will check for many but not all required packages and operating system features.  There is a list of known [package-dependencies](https://github.com/yahoo/state-space-testing/blob/master/PACKAGES.md) which you will need to install beyond your base operating system.

You may install this repo and its dependents by running the following command:

``` bash
git clone https://github.com/yahoo/state-space-testing.git
```

This will create a directory called `state-space-testing` and download the contents of this repo to it.

## Configuration

The build system is based upon [GNU Autotools](https://www.gnu.org/software/automake/manual/html_node/index.html).

The configuration of the repo consists of two steps which must be done once.
1. `./buildconf`
2. `./configure`

The first step performs some crude assessments of the build environment and creates the site-specific `configure'. Of course `configure --help` will explain the build options.  The general options to `configure` are widely [documented](https://www.gnu.org/prep/standards/html_node/Configuration.html).

The `buildconf` component is boilerplate and can be updated from [temerarious-flagship](https://github.com/yahoo/temerarious-flagship/blob/master/bc/template.autotools-buildconf) as needed.  The [Tunitas Build System](https://github.com/yahoo/temerarious-flagship) is expected to be available in `/opt/tunitas`. There is a template `buildconf` located at `/opt/tunitas/share/temerarious-flagship/bc/template.autotools-buildconf`

## Build

The simplest configure-compile-install recipe is:

``` bash
./buildconf &&
./configure &&
make all &&
make check &&
make install &&
echo OK DONE
```

## Usage

Each 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

[full-of-gravel](https://github.com/yahoo/state-space-testing/blob/master/tests/full-of-gravel) fills the database with random data.

Use `full-of-gravel --help`

### Reps and Sets

[reps-and-sets](https://github.com/yahoo/state-space-testing/blob/master/tests/reps-and-sets) exercises CRUD in the database with its own data set.

Use `reps-and-sets --help`

## Security

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](https://github.com/yahoo/state-space-packaging/blob/master/README.md#Security) in the [lead repo](https://github.com/yahoo/state-space-packaging) of the State Space Project.

## Contribute

Please refer to the [contribution instructions](Contributing.md) for information about how to get involved. We welcome issues, questions. Pull Requests are welcome.

Current work with modern-generation tooling, <em>e.g.</em> circa Fedora 36+ and GCC 12+, is occurring around the <em>v0.1-themed</em> feature branches.
## Maintainers
- Wendell Baker <wbaker@yahooinc.com>
- The State Space Team at Yahoo <state-space@yahooinc.com>
- <strike>The [IAB PrivacyChain Engineering Working Group](https://iabtechlab.com/working-groups/blockchain-working-group/)</strike> is no longer active.

You may contact us at least at <state-space@yahooinc.com>

## License

This project is licensed under the terms of the [Apache 2.0](http://www.apache.org/licenses/) open source license. Please refer to [LICENSE](https://github.com/yahoo/state-space-testing/blob/master/LICENSE) for the full terms.