Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use GenerateDocsMojo class of com.consol.citrus.mvn.plugin package

Best Citrus code snippet using com.consol.citrus.mvn.plugin.GenerateDocsMojo

Source:GenerateDocsMojo.java

...27 * @author Christoph Deppisch28 * @since 2.7.429 */30@Mojo(name = "generate-docs", defaultPhase = LifecyclePhase.PROCESS_TEST_RESOURCES)31public class GenerateDocsMojo extends AbstractCitrusMojo {32    @Parameter(property = "citrus.skip.generate.docs", defaultValue = "false")33    protected boolean skipGenerateDocs;34    private final ExcelTestDocsGenerator excelTestDocGenerator;35    private final HtmlTestDocsGenerator htmlTestDocGenerator;36    /**37     * Default constructor.38     */39    public GenerateDocsMojo() {40        this(new ExcelTestDocsGenerator(), new HtmlTestDocsGenerator());41    }42    /**43     * Constructor using final fields.44     * @param excelTestDocGenerator45     * @param htmlTestDocGenerator46     */47    public GenerateDocsMojo(ExcelTestDocsGenerator excelTestDocGenerator, HtmlTestDocsGenerator htmlTestDocGenerator) {48        this.excelTestDocGenerator = excelTestDocGenerator;49        this.htmlTestDocGenerator = htmlTestDocGenerator;50    }51    @Override52    public void doExecute() throws MojoExecutionException {53        if (skipGenerateDocs) {54            return;55        }56        if (getDocs().getExcel() != null) {57            ExcelTestDocsGenerator generator = getExcelTestDocGenerator();58            generator.withOutputFile(getDocs().getExcel().getOutputFile() + (getDocs().getExcel().getOutputFile().endsWith(".xls") ? "" : ".xls"))59                    .withPageTitle(getDocs().getExcel().getPageTitle())60                    .withAuthor(getDocs().getExcel().getAuthor())61                    .withCompany(getDocs().getExcel().getCompany())...

Source:GenerateDocsMojoTest.java

...30import static org.mockito.Mockito.when;31/**32 * @author Christoph Deppisch33 */34public class GenerateDocsMojoTest {35    private ExcelTestDocsGenerator excelTestDocGenerator = Mockito.mock(ExcelTestDocsGenerator.class);36    private HtmlTestDocsGenerator htmlTestDocGenerator = Mockito.mock(HtmlTestDocsGenerator.class);37    private GenerateDocsMojo mojo;38    39    @BeforeMethod40    public void setup() {41        mojo = new GenerateDocsMojo(excelTestDocGenerator, htmlTestDocGenerator);42    }43    44    @Test45    public void testCreateXls() throws PrompterException, MojoExecutionException, MojoFailureException {46        reset(excelTestDocGenerator);47        DocsConfiguration docs = new DocsConfiguration();48        ExcelDocConfiguration configuration = new ExcelDocConfiguration();49        configuration.setCompany("citrusframework.org");50        configuration.setAuthor("Citrus");51        configuration.setPageTitle("SampleTests");52        configuration.setOutputFile("SampleTests.xls");53        configuration.setHeaders("Id,Name,Description");54        docs.setExcel(configuration);55        when(excelTestDocGenerator.withCompany("citrusframework.org")).thenReturn(excelTestDocGenerator);...

GenerateDocsMojo

Using AI Code Generation

1import com.consol.citrus.mvn.plugin.GenerateDocsMojo;2import org.apache.maven.plugin.MojoExecutionException;3import org.apache.maven.plugin.MojoFailureException;4import org.apache.maven.plugin.testing.AbstractMojoTestCase;5import org.apache.maven.plugin.testing.MojoRule;6import org.junit.Rule;7import org.junit.Test;8import java.io.File;9import java.io.IOException;10import java.util.Properties;11public class GenerateDocsMojoTest extends AbstractMojoTestCase {12    public MojoRule rule = new MojoRule();13    public void testExecute() throws Exception {14        File pom = getTestFile("src/test/resources/pom.xml");15        assertNotNull(pom);16        assertTrue(pom.exists());17        GenerateDocsMojo mojo = (GenerateDocsMojo) lookupMojo("generate-docs", pom);18        assertNotNull(mojo);19        mojo.execute();20    }21}

GenerateDocsMojo

Using AI Code Generation

1package com.consol.citrus.mvn.plugin;2import org.apache.maven.plugin.MojoExecutionException;3import org.apache.maven.plugin.MojoFailureException;4import org.apache.maven.plugins.annotations.Mojo;5import org.apache.maven.plugins.annotations.Parameter;6import java.io.File;7import java.io.IOException;8import java.util.ArrayList;9import java.util.List;10@Mojo(name = "generate-docs")11public class GenerateDocsMojo extends AbstractCitrusMojo {12    @Parameter(property = "citrus.docs.outputDir", defaultValue = "${project.build.directory}/citrus/docs")13    private File outputDir;14    @Parameter(property = "citrus.docs.testClasses")15    private List<String> testClasses;16    @Parameter(property = "citrus.docs.testPackages")17    private List<String> testPackages;18    @Parameter(property = "citrus.docs.testDirs")19    private List<String> testDirs;20    public void execute() throws MojoExecutionException, MojoFailureException {21        if (testClasses == null) {22            testClasses = new ArrayList<String>();23        }24        if (testPackages == null) {25            testPackages = new ArrayList<String>();26        }27        if (testDirs == null) {28            testDirs = new ArrayList<String>();29        }30        try {31            new CitrusDocsGenerator().generateDocs(outputDir, testClasses, testPackages, testDirs);32        } catch (IOException e) {33            throw new MojoExecutionException("Failed to generate documentation", e);34        }35    }36}37package com.consol.citrus.mvn.plugin;38import java.io.File;39import java.io.FileWriter;40import java.io.IOException;41import java.util.List;42import com.consol.citrus.Citrus;43import com.consol.citrus.CitrusSettings;44import com.consol.citrus.docs.CitrusDocs;45import com.consol.citrus.docs.asciidoc.AsciidocGenerator;46import com.consol.citrus.docs.asciidoc.AsciidocTestGenerator;47import com.consol.citrus.docs.asciidoc.AsciidocTestSuiteGenerator;48import com.consol.citrus.docs.asciidoc.AsciidocTestSuiteListGenerator;49import org.slf4j.Logger;50import org.slf4j.LoggerFactory;

GenerateDocsMojo

Using AI Code Generation

1import com.consol.citrus.mvn.plugin.GenerateDocsMojo;2import org.apache.maven.plugin.testing.AbstractMojoTestCase;3import org.apache.maven.plugin.testing.stubs.MavenProjectStub;4import org.apache.maven.project.MavenProject;5import org.codehaus.plexus.util.FileUtils;6import org.junit.Test;7import java.io.File;8import java.util.ArrayList;9import java.util.List;10public class GenerateDocsMojoTest extends AbstractMojoTestCase {11    public void testExecute() throws Exception {12        File pom = getTestFile("src/test/resources/unit/generate-docs-mojo-test/pom.xml");13        assertNotNull(pom);14        assertTrue(pom.exists());15        GenerateDocsMojo mojo = (GenerateDocsMojo) lookupMojo("generate-docs", pom);16        assertNotNull(mojo);17        mojo.execute();18        File generatedFile = new File("target/test-classes/unit/generate-docs-mojo-test/target/generated-docs/generated-docs.xml");19        assertTrue(generatedFile.exists());20        String content = FileUtils.fileRead(generatedFile);21        assertTrue(content.contains("Hello Citrus!"));22    }23    protected void setUp() throws Exception {24        super.setUp();25    }26    protected void tearDown() throws Exception {27        super.tearDown();28        File generatedFile = new File("target/test-classes/unit/generate-docs-mojo-test/target/generated-docs/generated-docs.xml");29        if(generatedFile.exists()) {30            generatedFile.delete();31        }32    }33    protected String getCustomConfigurationName() {34        return "generate-docs-mojo-test";35    }36    protected void customizeContext() {37        super.customizeContext();38        context.put("project", new MavenProjectStub());39    }40}41[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ generate-docs-mojo-test ---42[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ generate-docs-mojo-test ---43[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ generate-docs-mojo-test ---

GenerateDocsMojo

Using AI Code Generation

1import com.consol.citrus.mvn.plugin.GenerateDocsMojo;2import org.apache.maven.plugin.testing.AbstractMojoTestCase;3import org.apache.maven.plugin.testing.MojoRule;4import org.apache.maven.plugin.testing.stubs.MavenProjectStub;5import org.junit.Rule;6import org.junit.Test;7import org.junit.rules.TemporaryFolder;8import java.io.File;9import java.io.IOException;10public class GenerateDocsMojoTest extends AbstractMojoTestCase {11    public TemporaryFolder testFolder = new TemporaryFolder();12    public MojoRule rule = new MojoRule();13    public void testExecute() throws Exception {14        File pom = getTestFile("src/test/resources/unit/generate-docs-mojo/pom.xml");15        assertNotNull(pom);16        assertTrue(pom.exists());17        GenerateDocsMojo mojo = (GenerateDocsMojo) rule.lookupMojo("generate-docs", pom);18        assertNotNull(mojo);19        mojo.execute();20    }21}

GenerateDocsMojo

Using AI Code Generation

1import com.consol.citrus.mvn.plugin.GenerateDocsMojo;2public class 4 {3    public static void main(String[] args) {4        GenerateDocsMojo obj = new GenerateDocsMojo();5        obj.execute();6    }7}

GenerateDocsMojo

Using AI Code Generation

1import com.consol.citrus.mvn.plugin.GenerateDocsMojo;2import com.consol.citrus.mvn.plugin.GenerateTestSuiteMojo;3import com.consol.citrus.mvn.plugin.GenerateWsdlMojo;4import com.consol.citrus.mvn.plugin.GenerateXsdMojo;5import com.consol.citrus.mvn.plugin.JavaDocMojo;6import com.consol.citrus.mvn.plugin.JavadocStubsMojo;7import com.consol.citrus.mvn.plugin.TestMojo;8import com.consol.citrus.mvn.plugin.Wsdl2JavaMojo;9import com.consol.citrus.mvn.plugin.Xsd2JavaMojo;10import com.consol.citrus.mvn.plugin.GenerateAntScriptMojo;11import com.consol.citrus.mvn.plugin.GenerateAntTestScriptMojo;12import com.consol.citrus.mvn.plugin.GenerateTestNgScriptMojo;13import com.consol.citrus.mvn.plugin.GenerateTestNgTestScriptMojo;

GenerateDocsMojo

Using AI Code Generation

1import org.apache.maven.plugin.MojoExecutionException;2import org.apache.maven.plugin.MojoFailureException;3import org.apache.maven.plugins.annotations.Mojo;4import org.apache.maven.plugins.annotations.Parameter;5import org.apache.maven.plugins.annotations.ResolutionScope;6import com.consol.citrus.mvn.plugin.GenerateDocsMojo;7@Mojo(name = "generate-docs", requiresDependencyResolution = ResolutionScope.TEST)8public class GenerateDocsMojo extends GenerateDocsMojo{9    @Parameter(property = "project.build.directory")10    private String projectBuildDirectory;11    @Parameter(property = "project.build.sourceDirectory")12    private String projectBuildSourceDirectory;13    @Parameter(property = "project.build.testSourceDirectory")14    private String projectBuildTestSourceDirectory;15    public void execute() throws MojoExecutionException, MojoFailureException {16        super.execute();17    }18    protected String getProjectBuildDirectory() {19        return projectBuildDirectory;20    }21    protected String getProjectBuildSourceDirectory() {22        return projectBuildSourceDirectory;23    }24    protected String getProjectBuildTestSourceDirectory() {25        return projectBuildTestSourceDirectory;26    }27}28<projectBuildDirectory>${project.build.directory}</projectBuildDirectory>29<projectBuildSourceDirectory>${project.build.sourceDirectory}</projectBuildSourceDirectory>30<projectBuildTestSourceDirectory>${project.build.testSourceDirectory}</projectBuildTestSourceDirectory>

GenerateDocsMojo

Using AI Code Generation

1package com.consol.citrus.mvn.plugin;2import java.io.File;3import java.util.ArrayList;4import java.util.List;5import org.apache.maven.plugin.MojoExecutionException;6import org.apache.maven.plugin.MojoFailureException;7import org.apache.maven.plugins.annotations.Mojo;8import org.apache.maven.plugins.annotations.Parameter;9import org.apache.maven.plugins.annotations.ResolutionScope;10@Mojo(name = "generate-docs", requiresDependencyResolution = ResolutionScope.TEST)11public class GenerateDocsMojo extends AbstractCitrusMojo {12    @Parameter(property = "citrus.generate.docs.testcases")13    private List<String> testCases = new ArrayList<String>();14    @Parameter(property = "citrus.generate.docs.targetDir", defaultValue = "target/citrus/docs")15    private File targetDir;16    @Parameter(property = "citrus.generate.docs.skip", defaultValue = "false")17    private boolean skip;18    public void execute() throws MojoExecutionException, MojoFailureException {19        if (skip) {20            return;21        }22        getLog().info("Generating Citrus test documentation for test cases: " + testCases);23        DocumentationGenerator generator = new DocumentationGenerator();24        generator.setTestCases(testCases);25        generator.setTargetDir(targetDir);26        generator.setLog(getLog());27        generator.generate();28    }29}30package com.consol.citrus.mvn.plugin;31import java.io.File;32import java.io.FileWriter;33import java.io.IOException;34import java.util.ArrayList;35import java.util.List;36import org.apache.maven.plugin.logging.Log;37import org.apache.maven.project.MavenProject;38import com.consol.citrus.TestCase;39import com.consol.citrus.TestCaseMetaInfo;40import com.consol.citrus.TestCaseMetaInfo.Status;41import com.consol.citrus.TestResult;42import com.consol.citrus.TestRunner;43import com.consol.citrus.actions.AbstractTestAction;44import com.consol.citrus.container.TestActionContainer;45import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;46import com.consol.citrus.exceptions.TestCaseFailedException;47import com.consol.citrus.report

GenerateDocsMojo

Using AI Code Generation

1package com.consol.citrus.mvn.plugin;2import com.consol.citrus.mvn.plugin.GenerateDocsMojo;3import java.io.File;4import java.io.IOException;5import java.util.ArrayList;6import java.util.List;7import org.apache.maven.plugin.MojoExecutionException;8import org.apache.maven.plugin.MojoFailureException;9import org.apache.maven.plugin.logging.Log;10import org.apache.maven.plugin.testing.AbstractMojoTestCase;11import org.apache.maven.project.MavenProject;12import org.codehaus.plexus.util.FileUtils;13import org.junit.Test;14public class GenerateDocsMojoTest extends AbstractMojoTestCase {15    public void testMojo() throws Exception {16        File testPom = getTestFile("src/test/resources/pom.xml");17        assertNotNull(testPom);18        assertTrue(testPom.exists());19        GenerateDocsMojo mojo = (GenerateDocsMojo) lookupMojo("generate-docs", testPom);20        assertNotNull(mojo);21        mojo.execute();22        File target = new File(getBasedir(), "target");23        File html = new File(target, "citrus-docs");24        assertTrue(html.exists());25        assertTrue(html.isDirectory());26        assertTrue(new File(html, "index.html").exists());27        assertTrue(new File(html, "test1.html").exists());28        assertTrue(new File(html, "test2.html").exists());29        assertTrue(new File(html, "test3.html").exists());30        assertTrue(new File(html, "test4.html").exists());31        assertTrue(new File(html, "test5.html").exists());32        assertTrue(new File(html, "test6.html").exists());33        assertTrue(new File(html, "test7.html").exists());34        assertTrue(new File(html, "test8.html").exists());35        assertTrue(new File(html, "test9.html").exists());36        assertTrue(new File(html, "test10.html").exists());37        assertTrue(new File(html, "test11.html").exists());38        assertTrue(new File(html, "test12.html").exists());39        assertTrue(new File(html, "test13.html").exists());40        assertTrue(new File(html, "test14.html").exists());41        assertTrue(new File(html, "test15.html").exists());42        assertTrue(new File(html, "test16.html").exists());43        assertTrue(new File(html, "test17.html").exists());44        assertTrue(new File(html, "test18.html").exists());

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.