datahub/wherehows-docs/coding-guidelines.md
2017-08-23 11:48:17 -07:00

1.6 KiB

Code Formatting

Use standard LinkedIn code style in IntelliJ to format the code.

License Header

Please add the Apache License Header to all source files. You can automate this using the licenseFormat gradle task.

Testing

Note: Info here is for pre-v1.0.0 and will need to be updated

In the metadata-etl model for local testing, it might have too many steps to set up a database and make all the configurations. So we provide a way to read all configurations from a local file. There is already a template of the configuration file in local_test.properties. You can find detail of properties in each job type's wiki.

If you are running the test through IDE, make sure the local_test.properties file location is correct (default at ~/.wherehows/local_test.properties)

Also, each ETL job can be run as a standalone job. The command line format is :

java -Dconfig=/path/to/config/file -cp "all the classpaths" metadata.etl.Launcher

parameter meaning
-Dconfig Config file location is the configs that you want to use to test the program. You can also sepcify each properties by using '-D', but it's more tedious
-cp Class path is all jar files location after you build the project. Normally after gradle build, the folder backend-service/lib contain all jar files

You can also add any JVM parameters such as -Xms512M -Xmx1024M for your testing purpose.

Example : java -Dconfig=/path/to/config/file -cp "lib/*" metadata.etl.Launcher