Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moban.rst: Doc on Moban Usage in Coala #601

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Prev Previous commit
Next Next commit
Add testing documentation in Moban.rst
  • Loading branch information
stephensonc committed Mar 11, 2020
commit 52bc667b25365dcb7bad0bfb02e883e8ca2bb23a
33 changes: 32 additions & 1 deletion Users/Moban.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,38 @@ Moban > moban.cd > moban.yml > template file = base.jj2 (in moban > templates)
Moban Key Features
-----------------

(based on test cases) Christopher's section
The layout of Moban’s test environment closely matches the layout of the actual
repository structure. This consistency helps to ensure that each file in the
source code has a corresponding test file. Additionally, if any test cases need
to be modified for any reason, they will be easy to locate due to the similar
file structure.

File structure of the tests directory:

tests
|_____core
|_____data_loaders
|_____deprecated
|_____fixtures
|_____integration_tests
|_____jinja2
|_____mobanfile
|_____regression_tests

The core folder includes tests related to context.py, engine, and moban_factory.py.
These tests ensure that the environment variables in context are initialized
correctly, that the jinja2 engine object that Moban creates functions properly,
and that all of the moban_factory functions correctly find the files that are
needed, whether it be templates or actual yml files.

The data_loaders folder checks that the json_loader, the dictionary merge
function, and the yaml_loader all successfully perform their tasks, while
test_overrides ensures that all overridden functions also work.

The fixtures folder contains testing files that are only created on initial run
of the test cases such that the test files are not stored in the production build
of moban.


Why Moban, and How?
-----------------
Expand Down