Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use createTestLoader method of com.consol.citrus.testng.AbstractTestNGCitrusTest class

Best Citrus code snippet using com.consol.citrus.testng.AbstractTestNGCitrusTest.createTestLoader

Source:AbstractTestNGCitrusTest.java

...55    @Override56    public void run(IHookCallBack callBack, ITestResult testResult) {57        Method method = testResult.getMethod().getConstructorOrMethod().getMethod();58        if (method != null && method.getAnnotation(CitrusXmlTest.class) != null) {59            List<TestLoader> methodTestLoaders = createTestLoadersForMethod(method);60            if (!CollectionUtils.isEmpty(methodTestLoaders)) {61                try {62                    run(testResult, method, methodTestLoaders.get(testResult.getMethod().getCurrentInvocationCount() % methodTestLoaders.size()),63                            testResult.getMethod().getCurrentInvocationCount());64                } catch (Exception e) {65                    testResult.setThrowable(e);66                    testResult.setStatus(ITestResult.FAILURE);67                }68            }69            super.run(new FakeExecutionCallBack(callBack.getParameters()), testResult);70            if (testResult.getThrowable() != null) {71                if (testResult.getThrowable() instanceof RuntimeException) {72                    throw (RuntimeException) testResult.getThrowable();73                } else {74                    throw new CitrusRuntimeException(testResult.getThrowable());75                }76            }77        } else {78            super.run(callBack, testResult);79        }80    }81    /**82     * Run method prepares and executes test case.83     * @param testResult84     * @param method85     * @param testLoader86     * @param invocationCount87     */88    protected void run(ITestResult testResult, Method method, TestLoader testLoader, int invocationCount) {89        if (citrus == null) {90            citrus = Citrus.newInstance(applicationContext);91        }92        TestContext ctx = prepareTestContext(citrus.createTestContext());93        TestCase testCase = testLoader.load();94        testCase.setGroups(testResult.getMethod().getGroups());95        invokeTestMethod(testResult, method, testCase, ctx, invocationCount);96    }97    /**98     * Invokes test method based on designer or runner environment.99     * @param testResult100     * @param method101     * @param testCase102     * @param context103     * @param invocationCount104     */105    protected void invokeTestMethod(ITestResult testResult, Method method, TestCase testCase, TestContext context, int invocationCount) {106        try {107            ReflectionUtils.invokeMethod(method, this,108                    resolveParameter(testResult, method, testCase, context, invocationCount));109            citrus.run(testCase, context);110        } catch (TestCaseFailedException e) {111            throw e;112        } catch (Exception | AssertionError e) {113            testCase.setTestResult(TestResult.failed(testCase.getName(), testCase.getTestClass().getName(), e));114            testCase.finish(context);115            throw new TestCaseFailedException(e);116        }117    }118    /**119     * Resolves method arguments supporting TestNG data provider parameters as well as120     * {@link CitrusResource} annotated methods.121     *122     * @param testResult123     * @param method124     * @param testCase125     * @param context126     * @param invocationCount127     * @return128     */129    protected Object[] resolveParameter(ITestResult testResult, final Method method, TestCase testCase, TestContext context, int invocationCount) {130        Object[] dataProviderParams = null;131        if (method.getAnnotation(Test.class) != null &&132                StringUtils.hasText(method.getAnnotation(Test.class).dataProvider())) {133            final Method[] dataProvider = new Method[1];134            ReflectionUtils.doWithMethods(method.getDeclaringClass(), current -> {135                if (StringUtils.hasText(current.getAnnotation(DataProvider.class).name()) &&136                        current.getAnnotation(DataProvider.class).name().equals(method.getAnnotation(Test.class).dataProvider())) {137                    dataProvider[0] = current;138                } else if (current.getName().equals(method.getAnnotation(Test.class).dataProvider())) {139                    dataProvider[0] = current;140                }141            }, toFilter -> toFilter.getAnnotation(DataProvider.class) != null);142            if (dataProvider[0] == null) {143                throw new CitrusRuntimeException("Unable to find data provider: " + method.getAnnotation(Test.class).dataProvider());144            }145            Object[][] parameters = (Object[][]) ReflectionUtils.invokeMethod(dataProvider[0], this,146                    resolveParameter(testResult, dataProvider[0], testCase, context, -1));147            if (parameters != null) {148                dataProviderParams = parameters[invocationCount % parameters.length];149                injectTestParameters(method, testCase, dataProviderParams);150            }151        }152        Object[] values = new Object[method.getParameterTypes().length];153        Class<?>[] parameterTypes = method.getParameterTypes();154        for (int i = 0; i < parameterTypes.length; i++) {155            final Annotation[] parameterAnnotations = method.getParameterAnnotations()[i];156            Class<?> parameterType = parameterTypes[i];157            for (Annotation annotation : parameterAnnotations) {158                if (annotation instanceof CitrusResource) {159                    values[i] = resolveAnnotatedResource(testResult, parameterType, context);160                }161            }162            if (parameterType.equals(ITestResult.class)) {163                values[i] = testResult;164            } else if (parameterType.equals(ITestContext.class)) {165                values[i] = testResult.getTestContext();166            } else if (values[i] == null && dataProviderParams != null && i < dataProviderParams.length) {167                values[i] = dataProviderParams[i];168            }169        }170        return values;171    }172    /**173     * Resolves value for annotated method parameter.174     *175     * @param testResult176     * @param parameterType177     * @return178     */179    protected Object resolveAnnotatedResource(ITestResult testResult, Class<?> parameterType, TestContext context) {180        if (TestContext.class.isAssignableFrom(parameterType)) {181            return context;182        } else {183            throw new CitrusRuntimeException("Not able to provide a Citrus resource injection for type " + parameterType);184        }185    }186    /**187     * Creates test loader from @CitrusXmlTest annotated test method and saves those to local member.188     * Test loaders get executed later when actual method is called by TestNG. This way user can annotate189     * multiple methods in one single class each executing several Citrus XML tests.190     *191     * @param method192     * @return193     */194    private List<TestLoader> createTestLoadersForMethod(Method method) {195        List<TestLoader> methodTestLoaders = new ArrayList<TestLoader>();196        if (method.getAnnotation(CitrusXmlTest.class) != null) {197            CitrusXmlTest citrusTestAnnotation = method.getAnnotation(CitrusXmlTest.class);198            String[] testNames = new String[] {};199            if (citrusTestAnnotation.name().length > 0) {200                testNames = citrusTestAnnotation.name();201            } else if (citrusTestAnnotation.packageScan().length == 0) {202                // only use default method name as test in case no package scan is set203                testNames = new String[] { method.getName() };204            }205            String testPackage;206            if (StringUtils.hasText(citrusTestAnnotation.packageName())) {207                testPackage = citrusTestAnnotation.packageName();208            } else {209                testPackage = method.getDeclaringClass().getPackage().getName();210            }211            for (String testName : testNames) {212                methodTestLoaders.add(createTestLoader(testName, testPackage));213            }214            String[] packagesToScan = citrusTestAnnotation.packageScan();215            for (String packageScan : packagesToScan) {216                try {217                    for (String fileNamePattern : Citrus.getXmlTestFileNamePattern()) {218                        Resource[] fileResources = new PathMatchingResourcePatternResolver().getResources(packageScan.replace('.', File.separatorChar) + fileNamePattern);219                        for (Resource fileResource : fileResources) {220                            String filePath = fileResource.getFile().getParentFile().getCanonicalPath();221                            if (packageScan.startsWith("file:")) {222                                filePath = "file:" + filePath;223                            }224                            225                            filePath = filePath.substring(filePath.indexOf(packageScan.replace('.', File.separatorChar)));226                            methodTestLoaders.add(createTestLoader(fileResource.getFilename().substring(0, fileResource.getFilename().length() - ".xml".length()), filePath));227                        }228                    }229                } catch (RuntimeException | IOException e) {230                    throw new CitrusRuntimeException("Unable to locate file resources for test package '" + packageScan + "'", e);231                }232            }233        }234        return methodTestLoaders;235    }236    /**237     * Runs tasks before test suite.238     * @param testContext the test context.239     * @throws Exception on error.240     */241    @BeforeSuite(alwaysRun = true)242    public void beforeSuite(ITestContext testContext) throws Exception {243        springTestContextPrepareTestInstance();244        Assert.notNull(applicationContext);245        citrus = Citrus.newInstance(applicationContext);246        citrus.beforeSuite(testContext.getSuite().getName(), testContext.getIncludedGroups());247    }248    /**249     * Runs tasks after test suite.250     * @param testContext the test context.251     */252    @AfterSuite(alwaysRun = true)253    public void afterSuite(ITestContext testContext) {254        if (citrus != null) {255            citrus.afterSuite(testContext.getSuite().getName(), testContext.getIncludedGroups());256        }257    }258    /**259     * Executes the test case.260     * @deprecated in favor of using {@link com.consol.citrus.annotations.CitrusXmlTest} or {@link com.consol.citrus.annotations.CitrusTest} annotations on test methods.261     */262    @Deprecated263    protected void executeTest() {264        if (citrus == null) {265            citrus = Citrus.newInstance(applicationContext);266        }267        ITestResult result = Reporter.getCurrentTestResult();268        ITestNGMethod testNGMethod = result.getMethod();269        TestContext context = prepareTestContext(citrus.createTestContext());270        TestLoader testLoader = createTestLoader(this.getClass().getSimpleName(), this.getClass().getPackage().getName());271        TestCase testCase = testLoader.load();272        testCase.setGroups(testNGMethod.getGroups());273        resolveParameter(result, testNGMethod.getConstructorOrMethod().getMethod(), testCase, context, testNGMethod.getCurrentInvocationCount());274        citrus.run(testCase, context);275    }276    /**277     * Prepares the test context.278     *279     * Provides a hook for test context modifications before the test gets executed.280     *281     * @param testContext the test context.282     * @return the (prepared) test context.283     */284    protected TestContext prepareTestContext(final TestContext testContext) {285        return testContext;286    }287    /**288     * Creates new test loader which has TestNG test annotations set for test execution. Only289     * suitable for tests that get created at runtime through factory method. Subclasses290     * may overwrite this in order to provide custom test loader with custom test annotations set.291     * @param testName292     * @param packageName293     * @return294     */295    protected TestLoader createTestLoader(String testName, String packageName) {296        return new XmlTestLoader(getClass(), testName, packageName, applicationContext);297    }298    /**299     * Constructs the test case to execute.300     * @return301     */302    protected TestCase getTestCase() {303        return createTestLoader(this.getClass().getSimpleName(), this.getClass().getPackage().getName()).load();304    }305    /**306     * Methods adds optional TestNG parameters as variables to the test case.307     *308     * @param method the method currently executed309     * @param testCase the constructed Citrus test.310     */311    protected void injectTestParameters(Method method, TestCase testCase, Object[] parameterValues) {312        testCase.setParameters(getParameterNames(method), parameterValues);313    }314    /**315     * Read parameter names form method annotation.316     * @param method317     * @return...

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testMyTest(TestNGCitrusTestDesigner builder) {3    builder.createTestLoader()4            .load("classpath:com/consol/citrus/MyTest.xml")5            .execute();6}7@Test(dataProvider = "testDataProvider")8public void testMyTest(TestNGCitrusTestDesigner builder) {9    builder.createTestLoader()10            .load("classpath:com/consol/citrus/MyTest.xml")11            .execute();12}13@Test(dataProvider = "testDataProvider")14public void testMyTest(TestNGCitrusTestDesigner builder) {15    builder.createTestLoader()16            .load("classpath:com/consol/citrus/MyTest.xml")17            .execute();18}19@Test(dataProvider = "testDataProvider")20public void testMyTest(TestNGCitrusTestDesigner builder) {21    builder.createTestLoader()22            .load("classpath:com/consol/citrus/MyTest.xml")23            .execute();24}25@Test(dataProvider = "testDataProvider")26public void testMyTest(TestNGCitrusTestDesigner builder) {27    builder.createTestLoader()28            .load("classpath:com/consol/citrus/MyTest.xml")29            .execute();30}31@Test(dataProvider = "testDataProvider")32public void testMyTest(TestNGCitrusTestDesigner builder) {33    builder.createTestLoader()34            .load("classpath:com/consol/citrus/MyTest.xml")35            .execute();36}37@Test(dataProvider = "testDataProvider")38public void testMyTest(TestNGCitrusTestDesigner builder) {39    builder.createTestLoader()40            .load("classpath:com/consol/citrus/MyTest.xml")

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testXpathExtractor(TestNGCitrusTestRunner runner) {3    runner.run(createTestLoader());4}5@Test(dataProvider = "testDataProvider")6public void testXpathExtractor(TestNGCitrusTestRunner runner) {7    runner.run(createTestLoader());8}9@Test(dataProvider = "testDataProvider")10public void testXpathExtractor(TestNGCitrusTestRunner runner) {11    runner.run(createTestLoader());12}13@Test(dataProvider = "testDataProvider")14public void testXpathExtractor(TestNGCitrusTestRunner runner) {15    runner.run(createTestLoader());16}

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testRunner(ITestContext testContext, TestCase testCase) {3    executeTest(testContext, testCase);4}5@Test(dataProvider = "testDataProvider")6public void testRunner(ITestContext testContext, TestCase testCase) {7    executeTest(testContext, testCase);8}9@Test(dataProvider = "testDataProvider")10public void testRunner(ITestContext testContext, TestCase testCase) {11    executeTest(testContext, testCase);12}13@Test(dataProvider = "testDataProvider")14public void testRunner(ITestContext testContext, TestCase testCase) {15    executeTest(testContext, testCase);16}17@Test(dataProvider = "testDataProvider")18public void testRunner(ITestContext testContext, TestCase testCase) {19    executeTest(testContext, testCase);20}21@Test(dataProvider = "testDataProvider")22public void testRunner(ITestContext testContext, TestCase testCase) {23    executeTest(testContext, testCase);24}25@Test(dataProvider = "testDataProvider")26public void testRunner(ITestContext testContext, TestCase testCase) {27    executeTest(testContext, testCase);28}29@Test(dataProvider = "testDataProvider")30public void testRunner(ITestContext testContext

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testXpathExtractor(TestNGCitrusTestRunner runner) {3    runner.run(createTestLoader());4}5@Test(dataProvider = "testDataProvider")6public void testXpathExtractor(TestNGCitrusTestRunner runner) {7    runner.run(createTestLoader());8}9@Test(dataProvider = "testDataProvider")10public void testXpathExtractor(TestNGCitrusTestRunner runner) {11    runner.run(createTestLoader());12}13@Test(dataProvider = "testDataProvider")14public void testXpathExtractor(TestNGCitrusTestRunner runner) {15    runner.run(createTestLoader());16}

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testRunner(ITestContext testContext, TestCase testCase) {3    executeTest(testContext, testCase);4}5@Test(dataProvider = "testDataProvider")6public void testRunner(ITestContext testContext, TestCase testCase) {7    executeTest(testContext, testCase);8}9@Test(dataProvider = "testDataProvider")10public void testRunner(ITestContext testContext, TestCase testCase) {11    executeTest(testContext, testCase);12}13@Test(dataProvider = "testDataProvider")14public void testRunner(ITestContext testContext, TestCase testCase) {15    executeTest(testContext, testCase);16}17@Test(dataProvider = "testDataProvider")18public void testRunner(ITestContext testContext, TestCase testCase) {19    executeTest(testContext, testCase);20}21@Test(dataProvider = "testDataProvider")22public void testRunner(ITestContext testContext, TestCase testCase) {23    executeTest(testContext, testCase);24}25@Test(dataProvider = "testDataProvider")26public void testRunner(ITestContext testContext, TestCase testCase) {27    executeTest(testContext, testCase);28}29@Test(dataProvider = "testDataProvider")30public void testRunner(ITestContext testContext

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "citrusDataProvider")2public void myTest(ITestContext testContext, TestCaseRunner runner) {3    runner.run(testContext);4}5@Test(dataProvider = "citrusDataProvider")6public void myTest(ITestContext testContext, TestCaseRunner runner) {7    runner.run(testContext);8}9@Test(dataProvider = "citrusDataProvider")10public void myTest(ITestContext testContext, TestCaseRunner runner) {11    runner.run(testContext);12}13@Test(dataProvider = "citrusDataProvider")14public void myTest(ITestContext testContext, TestCaseRunner runner) {15    runner.run(testContext);16}17@Test(dataProvider = "citrusDataProvider")18public void myTest(ITestContext testContext, TestCaseRunner runner) {19    runner.run(testContext);20}21@Test(dataProvider = "citrusDataProvider")22public void myTest(ITestContext testContext, TestCaseRunner runner) {23    runner.run(testContext);24}25@Test(dataProvider = "citrusDataProvider")26public void myTest(ITestContext testContext, TestCaseRunner runner) {27    runner.run(testContext);28}29@Test(dataProvider = "citrusDataProvider")30public void myTest(ITestContext testContext, TestCaseRunner runner) {31    runner.run(testContext);32}

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testXmlValidationWithTestNGDataProvider(ITestContext testContext, TestNGCitrusTestDesigner designer) {3    designer.createTestLoader()4        .load("classpath:com/consol/citrus/validation/xml-validation-test.xml")5        .execute();6}7public class XmlValidationTest extends AbstractTestNGCitrusTest {8    @DataProvider(name = "testDataProvider")9    public Object[][] testDataProvider() {10        return new Object[][] {11            new Object[] { "citrus:randomNumber(5)", "citrus:randomNumber(8)" }12        };13    }14}15public class XmlValidationTest extends AbstractTestNGCitrusTest {16    @DataProvider(name = "testDataProvider")17    public Iterator<Object[]> testDataProvider() {18        return Arrays.asList(new Object[][] {19            new Object[] { "citrus:randomNumber(5)", "citrus:randomNumber(8)" }20        }).iterator();21    }22}23public class XmlValidationTest extends AbstractTestNGCitrusTest {24    @DataProvider(name = "testDataProvider")25    public Iterator<Object[]> testDataProvider() {26        return new Iterator<Object[]>() {

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "citrusDataProvider")2public void testRunner(CitrusTestRunner runner) {3    runner.run(this);4}5@Test(dataProvider = "citrusDataProvider")6public void testRunner(CitrusTestRunner runner) {7    runner.run(this);8}9@Test(dataProvider = "citrusDataProvider")10public void testRunner(CitrusTestRunner runner) {11    runner.run(this);12}13@Test(dataProvider = "citrusDataProvider")14public void testRunner(CitrusTestRunner runner) {15    runner.run(this);16}17@Test(dataProvider = "citrusDataProvider")18public void testRunner(CitrusTestRunner runner) {19    runner.run(this);20}21@Test(dataProvider = "citrusDataProvider")22public void testRunner(CitrusTestRunner runner) {23    runner.run(this);24}25@Test(dataProvider = "citrusDataPrt

createTestLoader

Using AI Code Generation

1public void testCreateTestLoader() {2    createTestLoader("classpath:com/consol/citrus/actions/createTestLoader.citrus.xml");3}4public void testCreateTestBuilder() {5    createTestBuilder()6            .actions()7            .echo("Hello Citrus!")8            .createVariable("greeting", "Hello Citrus!")9            .echo("${greeting}")10            .end()11            .run();12}13public void testCreateTestBuilder() {14    createTestBuilder()15            .actions()16            .echo("Hello Citrus!")17            .createVariable("greeting", "Hello Citrus!")18            .echo("${greeting}")19            .end()20            .run();21}22public void testCreateTestBuilder() {23    createTestBuilder()24            .actions()25            .echo("Hello Citrus!")26            .createVariable("greeting", "Hello Citrus!")27            .echo("${greeting}")28            .end()29            .run();30}31public void testCreateTestBuilder() {32    createTestBuilder()33            .actions()34            .echo("Hello Citrus!")35            .createVariable("greeting", "Hello Citrus!")36            .echo("${greeting}")37            .end()38            .run();39}40public void testCreateTestBuilder() {41    createTestBuilder()42            .actions()43            .echo("Hello Citrus!")44            .createVariable("greeting", "vider")45public void testRunner(CitrusTestRunner runner) {46    runner.run(this);47}48@Test(dataProvider = "citrusDataProvider")49public void testRunner(CitrusTestRunner runner) {50    runner.run(this);51}

createTestLoader

Using AI Code Generation

1@Test(dataProvider = "testDataProvider")2public void testRunner(TestNGCitrusTestDesigner builder) {3    builder.run(testClass);4}5@DataProvider(name = "testDataProvider")6public Object[][] testDataProvider() {7    return createTestLoader().loadTestsFromPath("classpath:com/consol/citrus/demo/citrus-demo-testng.xml");8}

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.