KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

How to use DocumentationArtifactsLocation class of org.testingisdocumenting.webtau.documentation package

Best Webtau code snippet using org.testingisdocumenting.webtau.documentation.DocumentationArtifactsLocation

Source:CoreDocumentation.java

...40     * console output capture41     */42    public final CoreDocumentationConsole console = new CoreDocumentationConsole();43    /**44     * Captures value to a text or JSON file (based on the content) in parent location defined by {@link DocumentationArtifactsLocation}45     *46     * @param artifactName artifact name (file name without extension)47     * @param value value to capture48     */49    public void capture(String artifactName, Object value) {50        if (TypeUtils.isString(value)) {51            captureText(artifactName, value);52        } else {53            captureJson(artifactName, value);54        }55    }56    /**57     * Captures value to a text file in parent location defined by {@link DocumentationArtifactsLocation}58     *59     * @param artifactName artifact name (file name without extension)60     * @param value value to capture61     */62    public void captureText(String artifactName, Object value) {63        captureStep("text", artifactName, () -> DocumentationArtifacts.captureText(artifactName, value));64    }65    /**66     * Captures value to a JSON file in parent location defined by {@link DocumentationArtifactsLocation}67     *68     * @param artifactName artifact name (file name without extension)69     * @param value value to capture70     */71    public void captureJson(String artifactName, Object value) {72        captureStep("json", artifactName, () -> DocumentationArtifacts.captureJson(artifactName, value));73    }74    /**75     * Captures value to a CSV file in parent location defined by {@link DocumentationArtifactsLocation}76     *77     * @param artifactName artifact name (file name without extension)78     * @param value value to capture79     */80    public void captureCsv(String artifactName, Object value) {81        captureStep("csv", artifactName, () -> DocumentationArtifacts.captureCsv(artifactName, value));82    }83    private static CoreDocumentationAssertion findHandlerInRegistered() {84        return (CoreDocumentationAssertion) ExpectationHandlers.handlersStream()85                .filter(handler -> handler instanceof CoreDocumentationAssertion)86                .findFirst()87                .orElseThrow(() -> new IllegalStateException("CoreDocumentationAssertion must be registered with META-INF/services"));88    }89    private static void captureStep(String type, String artifactName, Supplier<Object> code) {...

Source:HttpTestBase.java

...14 * See the License for the specific language governing permissions and15 * limitations under the License.16 */17package org.testingisdocumenting.webtau.http;18import org.testingisdocumenting.webtau.documentation.DocumentationArtifactsLocation;19import org.testingisdocumenting.webtau.http.config.WebTauHttpConfiguration;20import org.testingisdocumenting.webtau.http.config.WebTauHttpConfigurations;21import org.testingisdocumenting.webtau.utils.UrlUtils;22import org.junit.After;23import org.junit.AfterClass;24import org.junit.Before;25import org.junit.BeforeClass;26import java.nio.file.Path;27import java.nio.file.Paths;28public class HttpTestBase implements WebTauHttpConfiguration {29    protected static final HttpTestDataServer testServer = new HttpTestDataServer();30    private static Path existingDocRoot;31    @BeforeClass32    public static void startServer() {33        testServer.start();34    }35    @AfterClass36    public static void stopServer() {37        testServer.stop();38    }39    @Before40    public void setupDocArtifacts() {41        existingDocRoot = DocumentationArtifactsLocation.getRoot();42        DocumentationArtifactsLocation.setRoot(Paths.get("doc-artifacts"));43    }44    @After45    public void restoreDocArtifacts() {46        DocumentationArtifactsLocation.setRoot(existingDocRoot);47    }48    @Before49    public void initCfg() {50        WebTauHttpConfigurations.add(this);51    }52    @After53    public void cleanCfg() {54        WebTauHttpConfigurations.remove(this);55    }56    @Override57    public String fullUrl(String url) {58        if (UrlUtils.isFull(url)) {59            return url;60        }...

Source:WebTauCoreConfigHandler.java

...13 * See the License for the specific language governing permissions and14 * limitations under the License.15 */16package org.testingisdocumenting.webtau.cfg;17import org.testingisdocumenting.webtau.documentation.DocumentationArtifactsLocation;18import org.testingisdocumenting.webtau.expectation.timer.SystemTimerConfig;19import java.nio.file.Path;20/**21 * <p>22 * core module doesn't depend on config so it can be used independently.23 * instead of using config to driver values of core modules you set values directly on certain components24 * e.g25 * {@link org.testingisdocumenting.webtau.expectation.timer.SystemTimerConfig#setWaitTimeout(int)}26 * {@link org.testingisdocumenting.webtau.documentation.DocumentationArtifactsLocation#setRoot(Path)}27 * <p>28 * this config handler is going to be run last and have access to config values.29 * It will set config values of the core components using config values provided by config handlers (e.g. config files)30 */31public class WebTauCoreConfigHandler implements WebTauConfigHandler {32    @Override33    public void onAfterCreate(WebTauConfig cfg) {34        SystemTimerConfig.setWaitTimeout(cfg.getWaitTimeout());35        DocumentationArtifactsLocation.setRoot(cfg.getDocArtifactsPath());36    }37}...