https://hugegraph.apache.org/docs/guides/dev-test/Recent content in Development & Testing on Apache HugeGraphHugoen-USMon, 02 Nov 2026 21:54:08 +0800https://hugegraph.apache.org/docs/guides/dev-test/toolchain-local-test/Mon, 01 Jan 0001 00:00:00 +0000https://hugegraph.apache.org/docs/guides/dev-test/toolchain-local-test/<p>This guide helps developers run HugeGraph toolchain tests locally.</p> <h2 id="1-core-concepts">1. Core Concepts </h2> <h3 id="11-core-dependency-hugegraph-server">1.1 Core Dependency: HugeGraph Server </h3> <p><strong>Integration and functional tests of the toolchain depend on HugeGraph Server</strong>, including Client, Loader, Hubble, Spark Connector, Tools, and other components.</p> <h3 id="12-test-types">1.2 Test Types </h3> <ul> <li><strong>Unit Tests</strong>: Test individual functions/methods, no external dependencies required</li> <li><strong>API Tests (ApiTestSuite)</strong>: Test API interfaces, requires running HugeGraph Server</li> <li><strong>Functional Tests (FuncTestSuite)</strong>: End-to-end tests, require complete system environment</li> </ul> <h2 id="2-environment-setup">2. Environment Setup </h2> <h3 id="21-system-requirements">2.1 System Requirements </h3> <ul> <li><strong>Operating System</strong>: Linux / macOS (Windows use WSL2)</li> <li><strong>JDK</strong>: &gt;= 11, configure <code>JAVA_HOME</code></li> <li><strong>Maven</strong>: &gt;= 3.6</li> <li><strong>Python</strong>: &gt;= 3.11 (only required for Hubble tests)</li> </ul> <h3 id="22-clone-code">2.2 Clone Code </h3> <div class="td-code td-code--untitled" id="td-code-71f81063-fence-0" data-td-code data-td-code-auto-id data-td-language="bash" data-td-line-count="2"> <div class="td-code__viewport" id="td-code-71f81063-fence-0-viewport" data-td-code-viewport><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="ln">1</span><span class="cl">git clone https://github.com/apache/hugegraph-toolchain.git </span></span><span class="line"><span class="ln">2</span><span class="cl"><span class="nb">cd</span> hugegraph-toolchain</span></span></code></pre></div></div> </div> <h2 id="3-deploy-test-environment">3. Deploy Test Environment </h2> <h3 id="deployment-options">Deployment Options </h3> <ul> <li><strong>Script Deployment</strong>: Specify a Server commit to reproduce the server version used by CI</li> <li><strong>Docker Deployment</strong>: Suitable for quick checks; if tests fail, first verify compatibility between the image and Toolchain</li> </ul> <blockquote> <p>For detailed installation instructions, refer to <a href="https://hugegraph.apache.org/docs/quickstart/hugegraph/hugegraph-server/">Community Documentation</a></p> </blockquote>https://hugegraph.apache.org/docs/guides/dev-test/toplingdb/Mon, 01 Jan 0001 00:00:00 +0000https://hugegraph.apache.org/docs/guides/dev-test/toplingdb/<blockquote> <p><strong>Development interface:</strong> This guide applies to development builds with the optional ToplingDB runtime enabled. Existing releases and image tags do not establish support, and runtime acceptance remains a deployment prerequisite.</p> </blockquote> <h2 id="choose-the-database-owner">Choose the database owner </h2> <p>HugeGraph defaults to standard RocksDB. Enable Topling separately for each process that owns local storage:</p> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Component</th> <th scope="col">Business provider setting</th> <th scope="col">Start command</th> </tr> </thead> <tbody> <tr> <td>Standalone RocksDB Server</td> <td><code>rocksdb.provider=topling</code> in each selected graph properties file</td> <td><code>bin/start-hugegraph.sh</code></td> </tr> <tr> <td>PD</td> <td><code>provider: topling</code> under <code>rocksdb</code> in <code>conf/application.yml</code></td> <td><code>bin/start-hugegraph-pd.sh</code></td> </tr> <tr> <td>Store</td> <td><code>provider: topling</code> under <code>rocksdb</code> in <code>conf/application-pd.yml</code></td> <td><code>bin/start-hugegraph-store.sh</code></td> </tr> </tbody> </table> </div> <p>A standalone Server keeps <code>backend=rocksdb</code>; an HStore-backed Server uses <code>backend=hstore</code> and needs no local Topling runtime. All local RocksDB graphs in one Server process must use the same provider. The business setting must match the runtime selected by its launcher.</p>