Changes between Version 3 and Version 4 of OAIHarvester/TestHarvesting

Timestamp:

05/27/20 12:26:11 (4 years ago)

Author:

Twan Goosen

Comment:

--

OAIHarvester/TestHarvesting

@@ -8 +8 @@
 == Running the test harvest ==
 
-* Clone [https://github.com/clarin-eric/test-oai-harvest] in a location with write access on the server (or locally if you prefer)
-* Prepare a harvester XML configuration file for the harvesting scenario to test. The repositories contains several configuration files that can be used as an example or template
-* Optionally: customise configuration (see the `test-oai-harvest` project's README for instructions)
-* Run the harvest - it's probably a good idea to do this in the background:
-
+1. Clone [https://github.com/clarin-eric/test-oai-harvest] in a location with write access on the server (or locally if you prefer)
+1. Prepare a harvester XML configuration file for the harvesting scenario to test. The repositories contains several configuration files that can be used as an example or template
+1. Optionally: customise configuration (see the `test-oai-harvest` project's README for instructions)
+1. Finally, run the harvest.\\ \\This following example that you have made a configuration file `my-provider.xml`.\\Output will in this case (assuming default configuration settings) go to `test-oai-harvest/output/my-provider`.\\ \\It's probably a good idea to run the script in the background:
 {{{#!sh
 cd test-oai-harvest
-nohup ./harvest.sh my-config &
+nohup ./harvest.sh my-provider &
 }}}
 
-This assumes that you have made a configuration file `my-config.xml`. Output will in this case (assuming default configuration settings) go to `test-oai-harvest/output/my-config`.
 
 == Importing the result into the alpha VLO ==
 
-After the harvest has completed, you can import the results into the VLO
+After the harvest has completed, you can import the results into the VLO. 
+
+1. Make the harvest output available to a location (e.g.`test-oai-harvest/output/my-config`) that can be read by the `deploy` user on the VLO host. We will call this location `$HARVEST_OUTPUT_SOURCE` (e.g. `HARVEST_OUTPUT_SOURCE=/tmp/output/my-provider`)
+1. Confirm that there exists a directory `${HARVEST_OUTPUT_SOURCE}/output/test/results` (if not, you may be able to find and use `${HARVEST_OUTPUT_SOURCE}/workdir/test-test/results`)
+1. Become the deploy user (`sudo su deploy`)
+1. Copy or move the result directory to the 'test data roots parent directory:
+{{{sh
+cp -r "${HARVEST_OUTPUT_SOURCE}/output/test /home/deploy/vlo-data/test/my-provider
+}}}
+1. Add the dataroot definition to the `/home/deploy/vlo/dataroots/testing-dataroots.xml`. Only `originName` and `rootFile` have to be customised for the specific case. For example:
+{{{#!xml
+<dataRoots>
+   ...
+   <DataRoot>
+        <originName>My provider</originName>
+        <rootFile>/srv/vlo-data/test/my-provider/results/cmdi/</rootFile>
+        <prefix>http://alpha-vlo.clarin.eu/data/</prefix>
+        <tostrip>/srv/vlo-data/</tostrip>
+        <deleteFirst>false</deleteFirst>
+  </DataRoot>
+  ..
+</dataRoots>
+}}}
+1. Restart the VLO compose project:
+{{{#!sh
+(cd /home/deploy && ./control.sh vlo restart)
+}}}
+6. After restart, you can run an import:
+{{{#!sh
+(cd /home/deploy && ./control.sh vlo run-import)
+}}}