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

Copied to Clipboard!

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

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

Source:AbstractTestNGCitrusTest.java

...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     * @return318     */319    protected String[] getParameterNames(Method method) {320        String[] parameterNames;321        CitrusParameters citrusParameters = method.getAnnotation(CitrusParameters.class);322        Parameters testNgParameters = method.getAnnotation(Parameters.class);323        if (citrusParameters != null) {324            parameterNames = citrusParameters.value();325        } else if (testNgParameters != null) {326            parameterNames = testNgParameters.value();327        } else {328            List<String> methodParameterNames = new ArrayList<>();329            for (Parameter parameter : method.getParameters()) {330                methodParameterNames.add(parameter.getName());331            }332            parameterNames = methodParameterNames.toArray(new String[methodParameterNames.size()]);333        }334        return parameterNames;335    }336    /**337     * Class faking test execution as callback. Used in run hookable method when test case338     * was executed before and callback is needed for super class run method invocation.339     */340    protected static final class FakeExecutionCallBack implements IHookCallBack {341        private Object[] parameters;342        public FakeExecutionCallBack(Object[] parameters) {343            this.parameters = Arrays.copyOf(parameters, parameters.length);344        }345        @Override346        public void runTestMethod(ITestResult testResult) {347            // do nothing as test case was already executed348        }349        @Override350        public Object[] getParameters() {351            return Arrays.copyOf(parameters, parameters.length);352        }353    }354}...

Source:TestNGCitrusTest.java

...58            } catch (Exception e) {59                testResult.setThrowable(e);60                testResult.setStatus(ITestResult.FAILURE);61            }62            super.run(new TestNGHelper.FakeExecutionCallBack(callBack.getParameters()), testResult);63            if (testResult.getThrowable() != null) {64                if (testResult.getThrowable() instanceof RuntimeException) {65                    throw (RuntimeException) testResult.getThrowable();66                } else {67                    throw new CitrusRuntimeException(testResult.getThrowable());68                }69            }70        } else {71            super.run(callBack, testResult);72        }73    }74    @Override75    protected void run(ITestResult testResult, Method method, TestLoader testLoader, int invocationCount) {76        if (method != null && method.getAnnotation(CitrusXmlTest.class) != null) {...

getParameters

Using AI Code Generation

1package com.consol.citrus.testng;2import org.testng.annotations.Test;3import com.consol.citrus.annotations.CitrusTest;4import com.consol.citrus.testng.AbstractTestNGCitrusTest;5import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;6public class 4 extends AbstractTestNGCitrusTest {7    public void 4(TestNGCitrusTestDesigner citrus) {8        citrus.echo(getParameters().get("name"));9    }10}11package com.consol.citrus.testng;12import org.testng.annotations.Test;13import com.consol.citrus.annotations.CitrusTest;14import com.consol.citrus.testng.AbstractTestNGCitrusTest;15import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;16public class 5 extends AbstractTestNGCitrusTest {17    public void 5(TestNGCitrusTestDesigner citrus) {18        citrus.echo(getParameters().get("name"));19    }20}21package com.consol.citrus.testng;22import org.testng.annotations.Test;23import com.consol.citrus.annotations.CitrusTest;24import com.consol.citrus.testng.AbstractTestNGCitrusTest;25import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;26public class 6 extends AbstractTestNGCitrusTest {27    public void 6(TestNGCitrusTestDesigner citrus) {28        citrus.echo(getParameters().get("name"));29    }30}31package com.consol.citrus.testng;32import org.testng.annotations.Test;33import com.consol.citrus.annotations.CitrusTest;34import com.consol.citrus.testng.AbstractTestNGCitrusTest;35import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;36public class 7 extends AbstractTestNGCitrusTest {

getParameters

Using AI Code Generation

1package com.consol.citrus.demo;2import com.consol.citrus.annotations.CitrusTest;3import com.consol.citrus.testng.AbstractTestNGCitrusTest;4import org.testng.annotations.Test;5import java.util.Map;6public class 4 extends AbstractTestNGCitrusTest {7    @Test(dataProvider = "testDataProvider")8    public void 4(Map<String, Object> parameters) {9        parameters = getParameters(parameters);10    }11}12package com.consol.citrus.demo;13import com.consol.citrus.annotations.CitrusTest;14import com.consol.citrus.testng.AbstractTestNGCitrusTest;15import org.testng.annotations.Test;16import java.util.Map;17public class 5 extends AbstractTestNGCitrusTest {18    @Test(dataProvider = "testDataProvider")19    public void 5(Map<String, Object> parameters) {20        parameters = getParameters(parameters);21    }22}23package com.consol.citrus.demo;24import com.consol.citrus.annotations.CitrusTest;25import com.consol.citrus.testng.AbstractTestNGCitrusTest;26import org.testng.annotations.Test;27import java.util.Map;28public class 6 extends AbstractTestNGCitrusTest {29    @Test(dataProvider = "testDataProvider")30    public void 6(Map<String, Object> parameters) {31        parameters = getParameters(parameters);32    }33}34package com.consol.citrus.demo;35import com.consol.citrus.annotations.CitrusTest;36import com.consol.citrus.testng.AbstractTestNGCitrusTest;37import org.testng.annotations.Test;38import java.util.Map;39public class 7 extends AbstractTestNGCitrusTest {40    @Test(dataProvider = "testDataProvider")41    public void 7(Map<String, Object> parameters) {42        parameters = getParameters(parameters);43    }44}

getParameters

Using AI Code Generation

1package com.consol.citrus;2import org.testng.annotations.Test;3import com.consol.citrus.annotations.CitrusTest;4import com.consol.citrus.context.TestContext;5import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;6import com.consol.citrus.testng.AbstractTestNGCitrusTest;7public class 4 extends AbstractTestNGCitrusTest {8public void 4() {9    TestContext context = getParameters().get(0);10    new TestNGCitrusTestRunner(context) {11        public void execute() {12            echo("Hello World!");13        }14    }.execute();15}16}17package com.consol.citrus;18import org.testng.annotations.Test;19import com.consol.citrus.annotations.CitrusTest;20import com.consol.citrus.context.TestContext;21import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;22import com.consol.citrus.testng.AbstractTestNGCitrusTest;23public class 5 extends AbstractTestNGCitrusTest {24public void 5() {25    TestContext context = getParameters().get(0);26    new TestNGCitrusTestRunner(context) {27        public void execute() {28            echo("Hello World!");29        }30    }.execute();31}32}33package com.consol.citrus;34import org.testng.annotations.Test;35import com.consol.citrus.annotations.CitrusTest;36import com.consol.citrus.context.TestContext;37import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;38import com.consol.citrus.testng.AbstractTestNGCitrusTest;39public class 6 extends AbstractTestNGCitrusTest {40public void 6() {41    TestContext context = getParameters().get(0);42    new TestNGCitrusTestRunner(context) {43        public void execute() {44            echo("Hello World!");45        }46    }.execute();47}48}

getParameters

Using AI Code Generation

1package com.consol.citrus.testng;2import org.testng.annotations.Test;3import com.consol.citrus.testng.AbstractTestNGCitrusTest;4import com.consol.citrus.context.TestContext;5import com.consol.citrus.context.TestContextFactory;6import com.consol.citrus.context.TestContextParameters;7import com.consol.citrus.exceptions.CitrusRuntimeException;8import com.consol.citrus.container.Sequence;9import com.consol.citrus.actions.EchoAction;10import com.consol.citrus.dsl.builder.BuilderSupport;11import com.consol.citrus.dsl.builder.AbstractTestContainerBuilder;12import com.consol.citrus.dsl.builder.AbstractActionBuilder;13import org.testng.annotations.DataProvider;14import java.util.List;15import java.util.ArrayList;16import java.util.Iterator;17import java.lang.reflect.Method;18import org.testng.annotations.BeforeMethod;19import org.testng.annotations.AfterMethod;20public class Test4 extends AbstractTestNGCitrusTest {21    public void beforeMethod(Method method) {22        TestContextParameters params = getParameters();23        params.setTestName(method.getName());24        params.setPackageName("com.consol.citrus.testng");25        params.setClassName(this.getClass().getName());26        params.setMethodName(method.getName());27        setParameters(params);28    }29    public void afterMethod() {30        setParameters(null);31    }32    public void test4() {33        TestContextParameters params = getParameters();34        params.setTestName("test4");35        params.setPackageName("com.consol.citrus.testng");36        params.setClassName(this.getClass().getName());37        params.setMethodName("test4");38        setParameters(params);39        TestContext context = new TestContextFactory().getObject();40        context.setTestParameters(params);41        Test4.test4(context);42    }43    @DataProvider(name = "test4")44    public static Iterator<Object[]> provideParameters() {45        List<Object[]> parameters = new ArrayList<Object[]>();46        TestContextParameters params = new TestContextParameters();47        params.setTestName("test4");48        params.setPackageName("com.consol.citrus.testng");49        params.setClassName("com.consol.citrus.testng.Test4");50        params.setMethodName("test4");51        TestContext context = new TestContextFactory().getObject();52        context.setTestParameters(params);53        parameters.add(new Object[] {context});54        return parameters.iterator();55    }

getParameters

Using AI Code Generation

1package com.consol.citrus;2import org.testng.annotations.Test;3public class Test4 extends AbstractTestNGCitrusTest {4    public void test4() {5        System.out.println("Test4");6        System.out.println(getParameters());7    }8}9package com.consol.citrus;10import org.testng.annotations.Test;11public class Test5 extends AbstractTestNGCitrusTest {12    public void test5() {13        System.out.println("Test5");14        System.out.println(getParameters());15    }16}17package com.consol.citrus;18import org.testng.annotations.Test;19public class Test6 extends AbstractTestNGCitrusTest {20    public void test6() {21        System.out.println("Test6");22        System.out.println(getParameters());23    }24}25package com.consol.citrus;26import org.testng.annotations.Test;27public class Test7 extends AbstractTestNGCitrusTest {28    public void test7() {29        System.out.println("Test7");30        System.out.println(getParameters());31    }32}33package com.consol.citrus;34import org.testng.annotations.Test;35public class Test8 extends AbstractTestNGCitrusTest {36    public void test8() {37        System.out.println("Test8");38        System.out.println(getParameters());39    }40}41package com.consol.citrus;42import org.testng.annotations.Test;43public class Test9 extends AbstractTestNGCitrusTest {44    public void test9() {45        System.out.println("Test9");46        System.out.println(getParameters());47    }48}

getParameters

Using AI Code Generation

1package com.consol.citrus;2import org.testng.annotations.Test;3public class 4 extends AbstractTestNGCitrusTest {4    public void test() {5        System.out.println("Parameters are: " + getParameters());6    }7}8Parameters are: {testName=test}

getParameters

Using AI Code Generation

1package com.consol.citrus;2import org.testng.annotations.Test;3public class 4 extends AbstractTestNGCitrusTest {4public void test() {5}6}7package com.consol.citrus;8import org.testng.annotations.Test;9public class 5 extends AbstractTestNGCitrusTest {10public void test() {11}12}13package com.consol.citrus;14import org.testng.annotations.Test;15public class 6 extends AbstractTestNGCitrusTest {16public void test() {17}18}19package com.consol.citrus;20import org.testng.annotations.Test;21public class 7 extends AbstractTestNGCitrusTest {22public void test() {23}24}25package com.consol.citrus;26import org.testng.annotations.Test;27public class 8 extends AbstractTestNGCitrusTest {28public void test() {29}30}31package com.consol.citrus;32import org.testng.annotations.Test;33public class 9 extends AbstractTestNGCitrusTest {34public void test() {35}36}37package com.consol.citrus;38import org.testng.annotations.Test;39public class 10 extends AbstractTestNGCitrusTest {40public void test() {41}42}43package com.consol.citrus;44import org.testng.annotations.Test;

getParameters

Using AI Code Generation

1package com.consol.citrus.testng;2import org.testng.annotations.Test;3public class 4 extends AbstractTestNGCitrusTest {4public void test() {5String param1 = getParameters().get("param1");6String param2 = getParameters().get("param2");7System.out.println("Param1: "+param1);8System.out.println("Param2: "+param2);9}10}

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.