[
https://issues.apache.org/jira/browse/DRILL-6249?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16469643#comment-16469643
]
ASF GitHub Bot commented on DRILL-6249:
---------------------------------------
ilooner commented on a change in pull request #1251: DRILL-6249: Adding more
unit testing documentation.
URL: https://github.com/apache/drill/pull/1251#discussion_r187199672
##########
File path: docs/dev/TempDirectories.md
##########
@@ -0,0 +1,17 @@
+# Temp Directory Utilities
+
+The two basic temp directory classes are:
+
+ -
[DirTestWatcher](../exec/java-exec/src/test/java/org/apache/drill/test/DirTestWatcher.java)
+ -
[BaseDirTestWatcher](../exec/java-exec/src/test/java/org/apache/drill/test/BaseDirTestWatcher.java)
+
+These classes are used to create temp directories for each of your unit tests.
The advantage to using
+these temp directory classes are:
+
+ - All files are deleted after a unit test completes. This prevents a build
machine being polluted with a
+ bunch of unit test files.
+ - Each unit test outputs its files to a unique well defined location. This
makes it easy to find files
+ for debugging. Also since each temp directory is unique, it prevents multiple
unit test runs from interferring
+ with one another on a build machine.
+
+For examples on how to use these classes, please read the javadoc for each
class.
Review comment:
Thanks for the info. I will add some examples to ExampleTest and will
document this in TestDataSets.md .
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Add Markdown Docs for Unit Testing and Link to it in README.md
> --------------------------------------------------------------
>
> Key: DRILL-6249
> URL: https://issues.apache.org/jira/browse/DRILL-6249
> Project: Apache Drill
> Issue Type: Improvement
> Reporter: Timothy Farkas
> Assignee: Timothy Farkas
> Priority: Major
> Labels: ready-to-commit
> Fix For: 1.14.0
>
>
> I am working on a presentation about how to use the unit testing utilities in
> Drill. Instead of writing the doc and having it be lost in Google Drive
> somewhere I am going to add a Markdown doc to the drill repo and link to it
> in the README.md. This is appropriate since these docs will only be used by
> developers, and the way we unit test will change as the code changes. So the
> unit testing docs should be kept in the same repo as the code so it can be
> updated and kept in sync with the rest of Drill.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
