[
https://issues.apache.org/jira/browse/DRILL-6249?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16468436#comment-16468436
]
ASF GitHub Bot commented on DRILL-6249:
---------------------------------------
paul-rogers commented on a change in pull request #1251: DRILL-6249: Adding
more unit testing documentation.
URL: https://github.com/apache/drill/pull/1251#discussion_r186934484
##########
File path:
exec/java-exec/src/test/java/org/apache/drill/test/BaseDirTestWatcher.java
##########
@@ -27,17 +27,31 @@
import java.nio.file.Paths;
/**
+ * <h4>Overview</h4>
* <p>
* This is a {@link DirTestWatcher} which creates all the temporary
directories required by a Drillbit and the various <b>dfs.*</b> storage
workspaces. It also
* provides convenience methods that do the following:
- * </p>
*
* <ol>
* <li>Copy project files to temp directories. This is useful for copying
the sample data into a temp directory.</li>
* <li>Copy resource files to temp.</li>
* <li>Updating parquet metadata files.</li>
* </ol>
+ * </p>
+ *
+ * <p>
+ * When used the {@link BaseDirTestWatcher} creates the following
directories in the <b>base temp directory</b> (for a description of where the
<b>base temp directory</b>
Review comment:
When used the --> The
----------------------------------------------------------------
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)
