Author: kwright
Date: Mon Mar 20 15:53:43 2017
New Revision: 1787801
URL: http://svn.apache.org/viewvc?rev=1787801&view=rev
Log:
Update documentation with instructions for setting up Selenium.
Modified:
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
Modified:
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml?rev=1787801&r1=1787800&r2=1787801&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
(original)
+++
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
Mon Mar 20 15:53:43 2017
@@ -1226,6 +1226,49 @@ mvn exec:exec
</section>
<section>
+ <title>Running ManifoldCF tests</title>
+ <p></p>
+ <p>ManifoldCF has a large suite of tests which helps verify the
integrity of a ManifoldCF release. These tests come in several varieties:</p>
+ <p></p>
+ <ul>
+ <li>Unit tests, which test specific classes</li>
+ <li>Integration tests, which test connectors running in the MCF
environment</li>
+ <li>Load tests, which are designed to run connectors under load over a
long period of time</li>
+ <li>UI tests, which are like integration tests but are meant to
exercise the UI</li>
+ </ul>
+ <p>There are no special considerations for unit tests. These are
executed across the whole project by the main ant target "run-tests".</p>
+ <p>Integration tests have a second dimension of variety, namely which
database the test is meant to run on. The testing databases are:</p>
+ <p></p>
+ <ul>
+ <li>HSQLDB (an embedded database)</li>
+ <li>HSQLDBext (running against HSQLDB as an external service)</li>
+ <li>PostgreSQL (requires a local installation of PostgreSQL to run
against)</li>
+ <li>MySQL (requires a local installation of MySQL to run against)</li>
+ </ul>
+ <p>For both the PostgreSQL and Mysql tests, the databases that are
installed locally must have a specific superuser and password set when they are
installed, so that the
+ tests can create a test database instance and tear it down again.
The superuser name and password for PostgreSQL should be "postgres"/"postgres".
The superuser name
+ and password for MySQL should be "root"/"mysql".</p>
+ <p>Once set up, you can run the tests you want against the database you
want by invoking the ant targets as follows:</p>
+ <table>
+ <caption>Databases and ant targets</caption>
+ <tr><th>Database</th><th>ant targets</th></tr>
+ <tr><td>HSQLDB, HSQLDBext</td><td>test-hs, load-hs</td></tr>
+ <tr><td>PostgreSQL</td><td>test-pg, load-pg</td></tr>
+ <tr><td>MySQL</td><td>test-my, load-my</td></tr>
+ </table>
+ <p></p>
+ <p>Running the UI tests requires some additional software installation
and configuration as well. This is what you will need:</p>
+ <p></p>
+ <ul>
+ <li>Install the Google Chrome browser on your testing machine</li>
+ <li>Download the appropriate Selenium Chrome driver from this <a
href="https://chromedriver.storage.googleapis.com/index.html?path=2.28/";>URL</a></li>
+ <li>Unpack the driver executable and place it in the location of your
choice</li>
+ <li>Set the environment variable <em>SL_CHROME_DRIVER</em> to point to
the executable</li>
+ </ul>
+ <p>After this, you should be able to run the UI tests using the ant
target "uitests". (This executes only the HSQLDB UI tests at this time.)</p>
+ </section>
+
+ <section>
<title>Integrating ManifoldCF into another application</title>
<p></p>
<p>ManifoldCF can be integrated into another application through a
variety of methods. We'll cover these below.</p>
Modified:
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml?rev=1787801&r1=1787800&r2=1787801&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
(original)
+++
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/ja_JP/how-to-build-and-deploy.xml
Mon Mar 20 15:53:43 2017
@@ -79,7 +79,9 @@
<p></p>
<ul>
<li>Alfresco Webscript connector</li>
+ <li>Amazon S3 connector</li>
<li>CMIS connector</li>
+ <li>Atlassian Confluence connector</li>
<li>EMC Documentum connector, built against a Documentum API
stub</li>
<li>DropBox connector</li>
<li>Email connector</li>
@@ -104,7 +106,9 @@
<ul>
<li>Active Directory authority</li>
<li>Alfresco Webscript authority</li>
+ <li>Amazon S3 authority</li>
<li>CMIS authority</li>
+ <li>Atlassian Confluence authority</li>
<li>EMC Documentum authority</li>
<li>Atlassian Jira authority</li>
<li>LDAP authority</li>
@@ -118,6 +122,7 @@
<p>The following output connectors will be built:</p>
<p></p>
<ul>
+ <li>Amazon Cloud Search output connector</li>
<li>WGET-compatible filesystem output connector</li>
<li>MetaCarta GTS output connector</li>
<li>Apache Solr output connector</li>
@@ -125,7 +130,9 @@
<li>ElasticSearch output connector</li>
<li>WGET-compatible filesystem output connector</li>
<li>HDFS output connector</li>
+ <li>Kafka output connector</li>
<li>Null output connector</li>
+ <li>Searchblox output connector</li>
</ul>
<p></p>
<p>The following transformation connectors will be built:</p>
@@ -133,6 +140,7 @@
<ul>
<li>Field mapping transformation connector</li>
<li>Document filter transformation connector</li>
+ <li>OpenNLP transformation connector</li>
<li>Null transformation connector</li>
<li>Tika extractor transformation connector</li>
</ul>
@@ -143,6 +151,12 @@
<li>Regular-expression mapping connector</li>
</ul>
<p></p>
+ <p>The following notification connectors will be built:</p>
+ <p></p>
+ <ul>
+ <li>Email notification connector</li>
+ </ul>
+ <p></p>
<p>The dependencies and build limitations of each individual LGPL and
proprietary connector is described in separate sections below.</p>
<p></p>
@@ -269,7 +283,19 @@
corresponding directory.</p>
<p></p>
</section>
-
+
+ <section>
+ <title>Running the Apache OpenNLP transformation connector</title>
+ <p></p>
+ <p>The Apache OpenNLP transformation connector requires OpenNLP
models in order to be useful. These models should be downloaded or created by
you, and
+ must be placed in the <em>file-resources</em> folder. This will
allow the connector to find them and allow you to use them.</p>
+ <p>The models available publicly for OpenNLP can be downloaded from
this URL: <a
href="http://opennlp.sourceforge.net/models-1.5/";>http://opennlp.sourceforge.net/models-1.5/</a>.
To use the
+ connector, you <strong>must</strong> specify a sentence model and
a tokenization model. You can specify as few or as many content extraction
models as you
+ wish.</p>
+ <p></p>
+ <p><strong>If you do not download or otherwise provide models for
the OpenNLP connector's use, it will not be possible to define a job which uses
the connector.</strong></p>
+ </section>
+
<section>
<title>Running the Apache Solr output connector</title>
<p></p>
@@ -477,6 +503,7 @@ mvn clean package
<tr><td><em>web-proprietary</em></td><td>app-server deployable web
applications (wars), including proprietary libraries; not included in binary
release</td></tr>
<tr><td><em>doc</em></td><td>javadocs for framework and all included
connectors</td></tr>
<tr><td><em>plugins</em></td><td>pre-built integration components to
deploy on target systems, e.g. for Solr</td></tr>
+ <tr><td><em>file-resources</em></td><td>a directory meant to contain
file resources that are identically present on all cluster members, e.g. models
for OpenNLP</td></tr>
</table>
<p></p>
<p>If you downloaded the binary distribution, you may notice that the
<em>connector-lib-proprietary</em> directory contains only a number of
@@ -504,6 +531,11 @@ mvn clean package
<p>The <em>plugins</em> directory contains components you may need to
deploy on the target system to make the associated connector function
correctly. For example, the Solr
connector includes plug-in classes for enforcing ManifoldCF
security on Solr 3.x and 4.x. See the README file in each directory for
detailed instructions on how to deploy the components.</p>
<p></p>
+ <p>The <em>file-resources</em> directory contains a README.txt file
plus any files your connectors specifically need access to across all cluster
members.
+ You should have an exact copy of this directory present on every
machine that a related ManifoldCF process runs on, and the properties.xml file
parameter
+ <em>org.apache.manifoldcf.fileresources</em> should point to it.
Any third-party or custom files needed by your connector configuration (e.g.
OpenNLP models)
+ should be created or downloaded and placed here.</p>
+ <p></p>
<p>Inside the <em>example</em> directory, you will find everything you
need to fire up ManifoldCF in a single-process model under Jetty. Everything
is included so that all you need to do is change
to that directory, and start it using the command <em><java>
-jar start.jar</em>. This is described in more detail later, and is the
recommended way for beginners to try out ManifoldCF.
The directory <em>example-proprietary</em> contains an equivalent
example that includes proprietary connectors and jars. This is the standard
place to start if you build ManifoldCF yourself.</p>
@@ -1194,6 +1226,49 @@ mvn exec:exec
</section>
<section>
+ <title>Running ManifoldCF tests</title>
+ <p></p>
+ <p>ManifoldCF has a large suite of tests which helps verify the
integrity of a ManifoldCF release. These tests come in several varieties:</p>
+ <p></p>
+ <ul>
+ <li>Unit tests, which test specific classes</li>
+ <li>Integration tests, which test connectors running in the MCF
environment</li>
+ <li>Load tests, which are designed to run connectors under load over a
long period of time</li>
+ <li>UI tests, which are like integration tests but are meant to
exercise the UI</li>
+ </ul>
+ <p>There are no special considerations for unit tests. These are
executed across the whole project by the main ant target "run-tests".</p>
+ <p>Integration tests have a second dimension of variety, namely which
database the test is meant to run on. The testing databases are:</p>
+ <p></p>
+ <ul>
+ <li>HSQLDB (an embedded database)</li>
+ <li>HSQLDBext (running against HSQLDB as an external service)</li>
+ <li>PostgreSQL (requires a local installation of PostgreSQL to run
against)</li>
+ <li>MySQL (requires a local installation of MySQL to run against)</li>
+ </ul>
+ <p>For both the PostgreSQL and Mysql tests, the databases that are
installed locally must have a specific superuser and password set when they are
installed, so that the
+ tests can create a test database instance and tear it down again.
The superuser name and password for PostgreSQL should be "postgres"/"postgres".
The superuser name
+ and password for MySQL should be "root"/"mysql".</p>
+ <p>Once set up, you can run the tests you want against the database you
want by invoking the ant targets as follows:</p>
+ <table>
+ <caption>Databases and ant targets</caption>
+ <tr><th>Database</th><th>ant targets</th></tr>
+ <tr><td>HSQLDB, HSQLDBext</td><td>test-hs, load-hs</td></tr>
+ <tr><td>PostgreSQL</td><td>test-pg, load-pg</td></tr>
+ <tr><td>MySQL</td><td>test-my, load-my</td></tr>
+ </table>
+ <p></p>
+ <p>Running the UI tests requires some additional software installation
and configuration as well. This is what you will need:</p>
+ <p></p>
+ <ul>
+ <li>Install the Google Chrome browser on your testing machine</li>
+ <li>Download the appropriate Selenium Chrome driver from this <a
href="https://chromedriver.storage.googleapis.com/index.html?path=2.28/";>URL</a></li>
+ <li>Unpack the driver executable and place it in the location of your
choice</li>
+ <li>Set the environment variable <em>SL_CHROME_DRIVER</em> to point to
the executable</li>
+ </ul>
+ <p>After this, you should be able to run the UI tests using the ant
target "uitests". (This executes only the HSQLDB UI tests at this time.)</p>
+ </section>
+
+ <section>
<title>Integrating ManifoldCF into another application</title>
<p></p>
<p>ManifoldCF can be integrated into another application through a
variety of methods. We'll cover these below.</p>
Modified:
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml?rev=1787801&r1=1787800&r2=1787801&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
(original)
+++
manifoldcf/branches/CONNECTORS-1196-2/site/src/documentation/content/xdocs/zh_CN/how-to-build-and-deploy.xml
Mon Mar 20 15:53:43 2017
@@ -79,7 +79,9 @@
<p></p>
<ul>
<li>Alfresco Webscript connector</li>
+ <li>Amazon S3 connector</li>
<li>CMIS connector</li>
+ <li>Atlassian Confluence connector</li>
<li>EMC Documentum connector, built against a Documentum API
stub</li>
<li>DropBox connector</li>
<li>Email connector</li>
@@ -104,7 +106,9 @@
<ul>
<li>Active Directory authority</li>
<li>Alfresco Webscript authority</li>
+ <li>Amazon S3 authority</li>
<li>CMIS authority</li>
+ <li>Atlassian Confluence authority</li>
<li>EMC Documentum authority</li>
<li>Atlassian Jira authority</li>
<li>LDAP authority</li>
@@ -118,6 +122,7 @@
<p>The following output connectors will be built:</p>
<p></p>
<ul>
+ <li>Amazon Cloud Search output connector</li>
<li>WGET-compatible filesystem output connector</li>
<li>MetaCarta GTS output connector</li>
<li>Apache Solr output connector</li>
@@ -125,7 +130,9 @@
<li>ElasticSearch output connector</li>
<li>WGET-compatible filesystem output connector</li>
<li>HDFS output connector</li>
+ <li>Kafka output connector</li>
<li>Null output connector</li>
+ <li>Searchblox output connector</li>
</ul>
<p></p>
<p>The following transformation connectors will be built:</p>
@@ -133,6 +140,7 @@
<ul>
<li>Field mapping transformation connector</li>
<li>Document filter transformation connector</li>
+ <li>OpenNLP transformation connector</li>
<li>Null transformation connector</li>
<li>Tika extractor transformation connector</li>
</ul>
@@ -143,6 +151,12 @@
<li>Regular-expression mapping connector</li>
</ul>
<p></p>
+ <p>The following notification connectors will be built:</p>
+ <p></p>
+ <ul>
+ <li>Email notification connector</li>
+ </ul>
+ <p></p>
<p>The dependencies and build limitations of each individual LGPL and
proprietary connector is described in separate sections below.</p>
<p></p>
@@ -269,7 +283,19 @@
corresponding directory.</p>
<p></p>
</section>
-
+
+ <section>
+ <title>Running the Apache OpenNLP transformation connector</title>
+ <p></p>
+ <p>The Apache OpenNLP transformation connector requires OpenNLP
models in order to be useful. These models should be downloaded or created by
you, and
+ must be placed in the <em>file-resources</em> folder. This will
allow the connector to find them and allow you to use them.</p>
+ <p>The models available publicly for OpenNLP can be downloaded from
this URL: <a
href="http://opennlp.sourceforge.net/models-1.5/";>http://opennlp.sourceforge.net/models-1.5/</a>.
To use the
+ connector, you <strong>must</strong> specify a sentence model and
a tokenization model. You can specify as few or as many content extraction
models as you
+ wish.</p>
+ <p></p>
+ <p><strong>If you do not download or otherwise provide models for
the OpenNLP connector's use, it will not be possible to define a job which uses
the connector.</strong></p>
+ </section>
+
<section>
<title>Running the Apache Solr output connector</title>
<p></p>
@@ -477,6 +503,7 @@ mvn clean package
<tr><td><em>web-proprietary</em></td><td>app-server deployable web
applications (wars), including proprietary libraries; not included in binary
release</td></tr>
<tr><td><em>doc</em></td><td>javadocs for framework and all included
connectors</td></tr>
<tr><td><em>plugins</em></td><td>pre-built integration components to
deploy on target systems, e.g. for Solr</td></tr>
+ <tr><td><em>file-resources</em></td><td>a directory meant to contain
file resources that are identically present on all cluster members, e.g. models
for OpenNLP</td></tr>
</table>
<p></p>
<p>If you downloaded the binary distribution, you may notice that the
<em>connector-lib-proprietary</em> directory contains only a number of
@@ -504,6 +531,11 @@ mvn clean package
<p>The <em>plugins</em> directory contains components you may need to
deploy on the target system to make the associated connector function
correctly. For example, the Solr
connector includes plug-in classes for enforcing ManifoldCF
security on Solr 3.x and 4.x. See the README file in each directory for
detailed instructions on how to deploy the components.</p>
<p></p>
+ <p>The <em>file-resources</em> directory contains a README.txt file
plus any files your connectors specifically need access to across all cluster
members.
+ You should have an exact copy of this directory present on every
machine that a related ManifoldCF process runs on, and the properties.xml file
parameter
+ <em>org.apache.manifoldcf.fileresources</em> should point to it.
Any third-party or custom files needed by your connector configuration (e.g.
OpenNLP models)
+ should be created or downloaded and placed here.</p>
+ <p></p>
<p>Inside the <em>example</em> directory, you will find everything you
need to fire up ManifoldCF in a single-process model under Jetty. Everything
is included so that all you need to do is change
to that directory, and start it using the command <em><java>
-jar start.jar</em>. This is described in more detail later, and is the
recommended way for beginners to try out ManifoldCF.
The directory <em>example-proprietary</em> contains an equivalent
example that includes proprietary connectors and jars. This is the standard
place to start if you build ManifoldCF yourself.</p>
@@ -1194,6 +1226,49 @@ mvn exec:exec
</section>
<section>
+ <title>Running ManifoldCF tests</title>
+ <p></p>
+ <p>ManifoldCF has a large suite of tests which helps verify the
integrity of a ManifoldCF release. These tests come in several varieties:</p>
+ <p></p>
+ <ul>
+ <li>Unit tests, which test specific classes</li>
+ <li>Integration tests, which test connectors running in the MCF
environment</li>
+ <li>Load tests, which are designed to run connectors under load over a
long period of time</li>
+ <li>UI tests, which are like integration tests but are meant to
exercise the UI</li>
+ </ul>
+ <p>There are no special considerations for unit tests. These are
executed across the whole project by the main ant target "run-tests".</p>
+ <p>Integration tests have a second dimension of variety, namely which
database the test is meant to run on. The testing databases are:</p>
+ <p></p>
+ <ul>
+ <li>HSQLDB (an embedded database)</li>
+ <li>HSQLDBext (running against HSQLDB as an external service)</li>
+ <li>PostgreSQL (requires a local installation of PostgreSQL to run
against)</li>
+ <li>MySQL (requires a local installation of MySQL to run against)</li>
+ </ul>
+ <p>For both the PostgreSQL and Mysql tests, the databases that are
installed locally must have a specific superuser and password set when they are
installed, so that the
+ tests can create a test database instance and tear it down again.
The superuser name and password for PostgreSQL should be "postgres"/"postgres".
The superuser name
+ and password for MySQL should be "root"/"mysql".</p>
+ <p>Once set up, you can run the tests you want against the database you
want by invoking the ant targets as follows:</p>
+ <table>
+ <caption>Databases and ant targets</caption>
+ <tr><th>Database</th><th>ant targets</th></tr>
+ <tr><td>HSQLDB, HSQLDBext</td><td>test-hs, load-hs</td></tr>
+ <tr><td>PostgreSQL</td><td>test-pg, load-pg</td></tr>
+ <tr><td>MySQL</td><td>test-my, load-my</td></tr>
+ </table>
+ <p></p>
+ <p>Running the UI tests requires some additional software installation
and configuration as well. This is what you will need:</p>
+ <p></p>
+ <ul>
+ <li>Install the Google Chrome browser on your testing machine</li>
+ <li>Download the appropriate Selenium Chrome driver from this <a
href="https://chromedriver.storage.googleapis.com/index.html?path=2.28/";>URL</a></li>
+ <li>Unpack the driver executable and place it in the location of your
choice</li>
+ <li>Set the environment variable <em>SL_CHROME_DRIVER</em> to point to
the executable</li>
+ </ul>
+ <p>After this, you should be able to run the UI tests using the ant
target "uitests". (This executes only the HSQLDB UI tests at this time.)</p>
+ </section>
+
+ <section>
<title>Integrating ManifoldCF into another application</title>
<p></p>
<p>ManifoldCF can be integrated into another application through a
variety of methods. We'll cover these below.</p>
