Project Folder Structure

ETLUnit 3.9.6

 

Draft in Progress

This document is a draft and is under development.

 

Chart of Project Folders

FolderCreated ByProject TypeUse
bin
  • mvn package
ETLUnitContains executables for starting ETLUnit command line shell.
lib
  • mvn package
ETLUnitContains jar file dependencies for the ETLUnit project.
src
  • project archetype
  • manual
AllMaven standard source folder.
src/main
  • project archetype
  • manual
AllMaven standard source folder for deployable source.
src/main/informatica
  • manual

ETLUnit

Contains parameter files and workflow XML for Informatica.
src/main/informatica/<InformaticaFolder>
  • manual
ETLUnitContains Informatica workflow XMLs
src/main/informatica/<InformaticaFolder>/ParameterFiles
  • manual
ETLUnitContains Informatica parameter files.
src/main/java
  • manual
ETLUnitJava source
src/main/reference/file/fml
  • project archetype
  • manual
ETLUnitFML files.  Such files should be stored here, not under src/test.
src/main/reference/file/fml/<alias>
  • manual
ETLUnitFML files.  <alias> refers to the alias package structure configured in reference-file-type-catalog.
src/main/reference/file/fml/<database>/<schema>
  • manual
All
  • FML files. 
  • Make accessible to ETLUnit test by configuring the package ("<database>/<schema>") in reference-file-type-catalog, which resides in src/main/reference/file/fml
  • The database and schema must be actual and configured for the project.
src/main/reference/file/fml/<package>
  • manual
ETLUnit
  • FML files. 
  • The <package> referred to here is the ETLUnit test package. 
  • ETLUnit test classes and supporting files may be placed in test folders, under src/test/etlunit
  • These test packages are named with a leading and trailing underscore ("_my_test_package_").
  • When referred to during test runtime, from the CLI, the leading and trailing underscores are dropped. 
  • When placed under src/main/reference/file/fml, their leading and trailing underscores are dropped.
src/main/resources/config
  • etlunit-database-schema-archetype
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-database-schema-archetype

ETLUnit

Db Schema

Contains database creation script(s), or subfolders containing such scripts.

Script files are usually .ddl or .sql files.

src/test
  • project archetype
  • manual
AllMaven standard source folder for test source.
src/test/etlunit
  • project archetype
  • manual
AllContains ETLUnit tests and supporting artifacts
src/test/etlunit/_<package_name>_
  • manual
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
  • manual
ETLUnitStore data files.
src/test/etlunit/_<package_name>_/dataset
  • manual
ETLUnit

Store data sets.

src/test/etlunit/_<package_name>_/files
  • manual
ETLUnitStore files that may contain data.
src/test/etlunit/_<package_name>_/log
  • manual
ETLUnitStore .expr files, for use with log assertion.
src/test/etlunit/_<package_name>_/sql
  • manual
ETLUnitStore SQL scripts.
src/test/etlunit/data
  • project archetype
  • manual
 Store data files.
src/test/etlunit/dataset
  • ?
  • manual
ETLUnitStore data sets.
src/test/etlunit/files
  • project archetype
  • manual
 Store files that may contain data.
src/test/etlunit/log
  • manual
 Store .expr files, for use with log assertion.
src/test/etlunit/sql
  • project archetype
  • manual
 Store SQL scripts.
target
  • Maven
AllMaven standard folder for runtime output.

 

Project Folders (Listed)

 

List of Project Folders

<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/

 

Go to top