Generate GoogleTest/GoogleMock Test Suites for C++ Interfaces

gen_um_test is a toolset for automatic generation of GoogleTest and GoogleMock test suites from C++ pure virtual interface headers.

Developed in python code.

The README is used to introduce the modules and provide instructions on how to install the modules, any machine dependencies it may have and any other information that should be provided before the modules are installed.

Table of Contents

🚀 Installation
📦 Dependencies
📁 Tool structure
- ✨ Features
📊 Code coverage
🛠 Usage
📚 Docs
👥 Contributing
📄 Copyright and licence

🚀 Installation

Used next development environment

Currently there are three ways to install package

Install process based on using pip mechanism
Install process based on build mechanism
Install process based on setup.py mechanism
Install process based on docker mechanism

Install using pip

gen_um_test is located at pypi.org.

You can install by using pip

# python3
pip3 install gen_um_test

Install using build

Navigate to release page download and extract release archive.

To install gen_um_test type the following

tar xvzf gen_um_test-x.y.z.tar.gz
cd gen_um_test-x.y.z/
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py 
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install ./dist/gen_um_test-*-py3-none-any.whl
rm -f get-pip.py

Install using py setup

Navigate to release page download and extract release archive.

To install gen_um_test locate and run setup.py with arguments

tar xvzf gen_um_test-x.y.z.tar.gz
cd gen_um_test-x.y.z
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info

Install using docker

You can use Dockerfile to create image/container.

📦 Dependencies

gen_um_test requires next modules and libraries

ats-utilities - Python App/Tool/Script Utilities

📁 Tool structure

gen_um_test is based on OOP.

Tool structure

Click to expand framework structure

    gen_um_test/
         ├── core/
         │   ├── __init__.py
         │   ├── model/
         │   │   ├── cpp_interface.py
         │   │   ├── cpp_method.py
         │   │   ├── generation_result.py
         │   │   ├── __init__.py
         │   │   └── test_suite_config.py
         │   └── service/
         │       ├── engine.py
         │       ├── icmake_generator.py
         │       ├── icpp_parser.py
         │       ├── ifake_generator.py
         │       ├── imock_generator.py
         │       ├── __init__.py
         │       ├── iservice.py
         │       ├── isubprocessor.py
         │       └── itest_generator.py
         ├── engine.py
         ├── infrastructure/
         │   ├── cli/
         │   │   ├── engine.py
         │   │   ├── icli.py
         │   │   ├── __init__.py
         │   │   └── setup/
         │   │       ├── bundle.py
         │   │       ├── dep_validator.py
         │   │       ├── dependencies.py
         │   │       ├── factory.py
         │   │       ├── __init__.py
         │   │       ├── keys.py
         │   │       ├── opt_validator.py
         │   │       ├── options.py
         │   │       ├── registry.py
         │   │       └── validator.py
         │   ├── command/
         │   │   ├── cmake_command_definition.py
         │   │   ├── cmake_command_executor.py
         │   │   ├── command.py
         │   │   ├── fake_command_definition.py
         │   │   ├── fake_command_executor.py
         │   │   ├── icommand_definition.py
         │   │   ├── icommand_executor.py
         │   │   ├── __init__.py
         │   │   ├── mock_command_definition.py
         │   │   ├── mock_command_executor.py
         │   │   ├── suite_command_definition.py
         │   │   ├── suite_command_executor.py
         │   │   ├── test_command_definition.py
         │   │   └── test_command_executor.py
         │   ├── config/
         │   │   ├── gen_um_test.cfg
         │   │   ├── gen_um_test.logo
         │   │   ├── scheme.json
         │   │   └── templates.tgz
         │   ├── generator/
         │   │   ├── cmake_generator.py
         │   │   ├── code_formatter.py
         │   │   ├── fake_generator.py
         │   │   ├── __init__.py
         │   │   ├── main_generator.py
         │   │   ├── mock_generator.py
         │   │   ├── template_provider.py
         │   │   └── test_generator.py
         │   ├── __init__.py
         │   ├── parser/
         │   │   ├── cpp_parser.py
         │   │   └── __init__.py
         │   ├── subprocessor.py
         │   └── templates/
         │       ├── cmake.template
         │       ├── fake.template
         │       ├── main.template
         │       ├── mock.template
         │       └── test.template
         ├── __init__.py
         ├── py.typed
         └── setup/
             ├── bundle.py
             ├── dep_validator.py
             ├── dependencies.py
             ├── factory.py
             ├── __init__.py
             ├── keys.py
             ├── opt_validator.py
             ├── options.py
             ├── registry.py
             └── validator.py

     13 directories, 76 files

✨ Features

Parses C++ pure virtual interface header files (.h / .hpp).
Synthesizes modern GoogleMock header mocks using MOCK_METHOD(...) with #pragma once.
Generates unit test suites (<interface>_test.cc), in-memory fake stubs (fake_<interface>.h), and test runners (test_main.cc).
Generates standalone CMakeLists.txt build scripts integrated with GoogleTest and GoogleMock.
Configurable template engine structured in templates.tgz with scheme.json schema validation.
Provides a modular and extensible architecture based on OOP, SOLID, and Hexagonal principles.
Includes command line interface (CLI) support via a command/executor structure.
High code quality with full type checking and 100% unit test coverage.

📊 Code coverage

Click to expand code coverage

Name	Stmts	Cover
`gen_um_test/__init__.py`	9	100%
`gen_um_test/core/__init__.py`	9	100%
`gen_um_test/core/model/__init__.py`	9	100%
`gen_um_test/core/model/cpp_interface.py`	43	100%
`gen_um_test/core/model/cpp_method.py`	43	100%
`gen_um_test/core/model/generation_result.py`	19	100%
`gen_um_test/core/model/test_suite_config.py`	23	100%
`gen_um_test/core/service/__init__.py`	9	100%
`gen_um_test/core/service/engine.py`	42	100%
`gen_um_test/core/service/icmake_generator.py`	14	100%
`gen_um_test/core/service/icpp_parser.py`	16	100%
`gen_um_test/core/service/ifake_generator.py`	15	100%
`gen_um_test/core/service/imock_generator.py`	15	100%
`gen_um_test/core/service/iservice.py`	20	100%
`gen_um_test/core/service/isubprocessor.py`	14	100%
`gen_um_test/core/service/itest_generator.py`	15	100%
`gen_um_test/engine.py`	57	100%
`gen_um_test/infrastructure/__init__.py`	9	100%
`gen_um_test/infrastructure/cli/__init__.py`	9	100%
`gen_um_test/infrastructure/cli/engine.py`	39	100%
`gen_um_test/infrastructure/cli/icli.py`	14	100%
`gen_um_test/infrastructure/cli/setup/__init__.py`	9	100%
`gen_um_test/infrastructure/cli/setup/bundle.py`	22	100%
`gen_um_test/infrastructure/cli/setup/dep_validator.py`	36	100%
`gen_um_test/infrastructure/cli/setup/dependencies.py`	18	100%
`gen_um_test/infrastructure/cli/setup/factory.py`	49	100%
`gen_um_test/infrastructure/cli/setup/keys.py`	26	100%
`gen_um_test/infrastructure/cli/setup/opt_validator.py`	36	100%
`gen_um_test/infrastructure/cli/setup/options.py`	15	100%
`gen_um_test/infrastructure/cli/setup/registry.py`	24	100%
`gen_um_test/infrastructure/cli/setup/validator.py`	43	100%
`gen_um_test/infrastructure/command/__init__.py`	9	100%
`gen_um_test/infrastructure/command/cmake_command_definition.py`	24	100%
`gen_um_test/infrastructure/command/cmake_command_executor.py`	28	100%
`gen_um_test/infrastructure/command/command.py`	16	100%
`gen_um_test/infrastructure/command/fake_command_definition.py`	24	100%
`gen_um_test/infrastructure/command/fake_command_executor.py`	28	100%
`gen_um_test/infrastructure/command/icommand_definition.py`	14	100%
`gen_um_test/infrastructure/command/icommand_executor.py`	14	100%
`gen_um_test/infrastructure/command/mock_command_definition.py`	24	100%
`gen_um_test/infrastructure/command/mock_command_executor.py`	28	100%
`gen_um_test/infrastructure/command/suite_command_definition.py`	24	100%
`gen_um_test/infrastructure/command/suite_command_executor.py`	28	100%
`gen_um_test/infrastructure/command/test_command_definition.py`	24	100%
`gen_um_test/infrastructure/command/test_command_executor.py`	28	100%
`gen_um_test/infrastructure/generator/__init__.py`	9	100%
`gen_um_test/infrastructure/generator/cmake_generator.py`	32	100%
`gen_um_test/infrastructure/generator/code_formatter.py`	28	100%
`gen_um_test/infrastructure/generator/fake_generator.py`	57	100%
`gen_um_test/infrastructure/generator/main_generator.py`	26	100%
`gen_um_test/infrastructure/generator/mock_generator.py`	46	100%
`gen_um_test/infrastructure/generator/template_provider.py`	75	100%
`gen_um_test/infrastructure/generator/test_generator.py`	68	100%
`gen_um_test/infrastructure/parser/__init__.py`	9	100%
`gen_um_test/infrastructure/parser/cpp_parser.py`	110	100%
`gen_um_test/infrastructure/subprocessor.py`	122	100%
`gen_um_test/setup/__init__.py`	9	100%
`gen_um_test/setup/bundle.py`	23	100%
`gen_um_test/setup/dep_validator.py`	36	100%
`gen_um_test/setup/dependencies.py`	19	100%
`gen_um_test/setup/factory.py`	58	100%
`gen_um_test/setup/keys.py`	27	100%
`gen_um_test/setup/opt_validator.py`	36	100%
`gen_um_test/setup/options.py`	12	100%
`gen_um_test/setup/registry.py`	24	100%
`gen_um_test/setup/validator.py`	48	100%
Total	1908	100%

🛠 Usage

Install package

pip3 install gen_um_test

Prepare main entry point by downloading main.py or create your own.

wget -O main.py https://raw.githubusercontent.com/electux/gen_um_test/main/main.py

Running tool for generating complete GoogleTest suite:

python3 main.py suite --interface include/ISerialPort.h --output ./tests --prefix comm

Running tool for generating individual components:

python3 main.py mock --interface include/ISerialPort.h --output ./tests
python3 main.py test --interface include/ISerialPort.h --output ./tests
python3 main.py fake --interface include/ISerialPort.h --output ./tests
python3 main.py cmake --interface include/ISerialPort.h --output ./tests

📚 Docs

👥 Contributing

Contributing to gen_um_test

📄 Copyright and licence

gen_um_test is free software; you can redistribute it and/or modify it under the same terms as Python itself, either Python version 3.x or, at your option, any later version of Python 3 you may have available.

Lets help and support PSF.

Name		Name	Last commit message	Last commit date
.github		.github
.vscode		.vscode
coverage		coverage
docs		docs
gates		gates
gen_um_test		gen_um_test
tests		tests
.coveragerc		.coveragerc
.editorconfig		.editorconfig
.gitignore		.gitignore
.gitmodules		.gitmodules
.pylintrc		.pylintrc
.readthedocs.yml		.readthedocs.yml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.md		README.md
gen_um_test.code-workspace		gen_um_test.code-workspace
main.py		main.py
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt
run_coverage.sh		run_coverage.sh
run_quality_gates.sh		run_quality_gates.sh
setup.py		setup.py

Navigation Menu

Repository navigation

About

Repository files navigation

Generate GoogleTest/GoogleMock Test Suites for C++ Interfaces

🚀 Installation

Install using pip

Install using build

Install using py setup

Install using docker

📦 Dependencies

📁 Tool structure

✨ Features

📊 Code coverage

🛠 Usage

📚 Docs

👥 Contributing

📄 Copyright and licence

About

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

Generate GoogleTest/GoogleMock Test Suites for C++ Interfaces

🚀 Installation

Install using pip

Install using build

Install using py setup

Install using docker

📦 Dependencies

📁 Tool structure

✨ Features

📊 Code coverage

🛠 Usage

📚 Docs

👥 Contributing

📄 Copyright and licence

About

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages