Test-Setup.html

<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>eprinttools</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<a href="#main-content" class="visually-hidden">skip to main content</a>
<nav>
<ul>
    <li><a href="/">All Library Apps</a></li>
    <li><a href="index.html">Home</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <!-- <li><a href="about.html">About</a></li> -->
    <!-- <li><a href="search.html">Search</a></li> -->
    <li><a href="https://github.com/caltechlibrary/eprinttools">Code Repository</a></li>
</ul>
</nav>
<section id="main-content">
<h1 id="test-setup">Test Setup</h1>
<p>It is important to be able to test the code that makes up
eprinttools. EPrints is complex and nuanced and testing helps insure
that our code is addressing that. For running the test suite you need to
have MySQL setup with a test database and one or more EPrints repository
available and setup for REST access. The REST client testing is read
only and can be skipped if you’re not using it. You need at least one
MySQL database setup using the same structure that is present in our
EPrints 3.3.16 repositories. You also need a “test-settings.json” file
for the configured test.</p>
<p>The test database used to test both SQL level interaction (which
includes writes and deletes) should be named “lemurprints”. It should
now have records in it when you start. The Scheme for that database is
found in the directory
<code>srctest/lemurprints-setup-schema.sql</code>. Assuming your MySQL
client is configured for loading databased you can run</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a>    <span class="ex">mysql</span> <span class="at">--execute</span> <span class="st">&#39;CREATE DATABASE IF NOT EXIST lemurprints&#39;</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>    <span class="ex">mysql</span> lemurprints <span class="op">&lt;</span> srctest/lemurprints-setup-schema.sql</span></code></pre></div>
<p>You’re <code>test-settings.json</code> file should look something
like this (replace the text in capital letters appropriately).</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode json"><code class="sourceCode json"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">{</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;logfile&quot;</span><span class="fu">:</span> <span class="st">&quot;eprinttools-test.log&quot;</span><span class="fu">,</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a>    <span class="dt">&quot;repositories&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>        <span class="dt">&quot;lemurprints&quot;</span><span class="fu">:</span> <span class="fu">{</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;dsn&quot;</span><span class="fu">:</span> <span class="st">&quot;USERNAME:PASSWORD@/lemurprints&quot;</span><span class="fu">,</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;base_url&quot;</span><span class="fu">:</span> <span class="st">&quot;http://lemurprints.example.edu&quot;</span><span class="fu">,</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;rest&quot;</span><span class="fu">:</span> <span class="st">&quot;https://USERNAME:PASSWORD@TEST_HOSTNAME_FOR_REST_CLIENT&quot;</span><span class="fu">,</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a>            <span class="dt">&quot;write&quot;</span><span class="fu">:</span> <span class="kw">true</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a>        <span class="fu">}</span></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a>    <span class="fu">}</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a><span class="fu">}</span></span></code></pre></div>
<p>You can omit the “rest” key/value if you’re not going to test the
REST client.</p>
<p>When running tests any log output will be sent to the “logfile”
value. If that is not set then you’ll have at least one test failure
(the one testing if log is being sent to a file).</p>
<p>The test database “lemurprints” need to be “write” enabled. If you
add additional repository databases DO NOT enable “write” as the test
sequence will attempt to clear the database before each test run.</p>
</section>
<footer-global></footer-global>
</body>
</html>