Project Folder Structure
Draft in Progress
This document is a draft and is under development.
Chart of Project Folders
Folder | Created By | Project Type | Use |
---|---|---|---|
bin |
| ETLUnit | Contains executables for starting ETLUnit command line shell. |
lib |
| ETLUnit | Contains jar file dependencies for the ETLUnit project. |
src |
| All | Maven standard source folder. |
src/main |
| All | Maven standard source folder for deployable source. |
src/main/informatica |
| ETLUnit | Contains parameter files and workflow XML for Informatica. |
src/main/informatica/<InformaticaFolder> |
| ETLUnit | Contains Informatica workflow XMLs |
src/main/informatica/<InformaticaFolder>/ParameterFiles |
| ETLUnit | Contains Informatica parameter files. |
src/main/java |
| ETLUnit | Java source |
src/main/reference/file/fml |
| ETLUnit | FML files. Such files should be stored here, not under src/test. |
src/main/reference/file/fml/<alias> |
| ETLUnit | FML files. <alias> refers to the alias package structure configured in reference-file-type-catalog. |
src/main/reference/file/fml/<database>/<schema> |
| All |
|
src/main/reference/file/fml/<package> |
| ETLUnit |
|
src/main/resources/config |
| Db Schema | JSON configuration files for one of the schema modules. Usually contains etlunit.json, which provides database ID's that are referred to in @Database annotations in an ETLUnit test class file. |
src/main/sql-server/<db_id> |
| ETLUnit Db Schema | Contains database creation script(s), or subfolders containing such scripts. Script files are usually .ddl or .sql files. |
src/test |
| All | Maven standard source folder for test source. |
src/test/etlunit |
| All | Contains ETLUnit tests and supporting artifacts |
src/test/etlunit/_<package_name>_ |
| ETLUnit | A subfolder to group a set of ETLUnit tests. When referred to during testing, take off the leading and trailing underscores. For instance, on the command line: test %myTests will run all unit tests under folder _myTests_ |
src/test/etlunit/_<package_name>_/data |
| ETLUnit | Store data files. |
src/test/etlunit/_<package_name>_/dataset |
| ETLUnit | Store data sets. |
src/test/etlunit/_<package_name>_/files |
| ETLUnit | Store files that may contain data. |
src/test/etlunit/_<package_name>_/log |
| ETLUnit | Store .expr files, for use with log assertion. |
src/test/etlunit/_<package_name>_/sql |
| ETLUnit | Store SQL scripts. |
src/test/etlunit/data |
| Store data files. | |
src/test/etlunit/dataset |
| ETLUnit | Store data sets. |
src/test/etlunit/files |
| Store files that may contain data. | |
src/test/etlunit/log |
| Store .expr files, for use with log assertion. | |
src/test/etlunit/sql |
| Store SQL scripts. | |
target |
| All | Maven standard folder for runtime output. |
Project Folders (Listed)
<Project_Folder>/
bin/
lib/
src/
main/
informatica/<informaticaFolder>/
ParameterFiles/
java/
reference/file/fml/
reference/file/fml/
<database>/<schema>/
<package>/
resources/config/
sql-server/<db_id>/
test/
etlunit/
_<package_name>_/
data/
dataset/
files/
log/
sql/
data/
dataset/
files/
log/
sql/
target/