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

How to use TemplateBasedScriptBuilder method of com.consol.citrus.validation.script.TemplateBasedScriptBuilder class

Best Citrus code snippet using com.consol.citrus.validation.script.TemplateBasedScriptBuilder.TemplateBasedScriptBuilder

Source:TemplateBasedScriptBuilder.java

...23 * script template.24 * 25 * @author Christoph Deppisch26 */27public final class TemplateBasedScriptBuilder {28    /** Placeholder identifier for script body in template */29    private static final String BODY_PLACEHOLDER = "@SCRIPTBODY@";30    31    /** Head and tail for script */32    private String scriptHead;33    private String scriptTail;34    35    /** Code snippet which is dynamically added to the script */36    private String scriptCode = "";37    38    /**39     * Constructor using script template string.40     * @param scriptTemplate41     */42    private TemplateBasedScriptBuilder(String scriptTemplate) {43        if (!scriptTemplate.contains(BODY_PLACEHOLDER)) {44            throw new CitrusRuntimeException("Invalid script template - please define '" + 45                    BODY_PLACEHOLDER + "' placeholder where your code comes in");46        }47        48        scriptHead = scriptTemplate.substring(0, scriptTemplate.indexOf(BODY_PLACEHOLDER));49        scriptTail = scriptTemplate.substring((scriptTemplate.indexOf(BODY_PLACEHOLDER) + BODY_PLACEHOLDER.length()));50    }51    52    /**53     * Builds the final script.54     */55    public String build() {56        StringBuilder scriptBuilder = new StringBuilder();57        StringBuilder scriptBody = new StringBuilder();58        String importStmt = "import ";59        60        try {61            if (scriptCode.contains(importStmt)) {62                BufferedReader reader = new BufferedReader(new StringReader(scriptCode));63                String line;64                while ((line = reader.readLine()) != null) {65                    if (line.trim().startsWith(importStmt)) {66                        scriptBuilder.append(line);67                        scriptBuilder.append("\n");68                    } else {69                        scriptBody.append((scriptBody.length() == 0 ? "" : "\n"));70                        scriptBody.append(line);71                    }72                }73            } else {74                scriptBody.append(scriptCode);75            }76        } catch (IOException e) {77            throw new CitrusRuntimeException("Failed to construct script from template", e);78        }79        80        scriptBuilder.append(scriptHead);81        scriptBuilder.append(scriptBody.toString());82        scriptBuilder.append(scriptTail);83        84        return scriptBuilder.toString();85    }86    87    /**88     * Adds custom code snippet to this builder.89     * 90     * @param code the custom code body91     * @return92     */93    public TemplateBasedScriptBuilder withCode(String code) {94        this.scriptCode = code;95        return this;96    }97    98    /**99     * Static construction method returning a fully qualified instance of this builder.100     * @param scriptTemplate the script template code.101     * @return instance of this builder.102     */103    public static TemplateBasedScriptBuilder fromTemplateScript(String scriptTemplate) {104        return new TemplateBasedScriptBuilder(scriptTemplate);105    }106    107    /**108     * Static construction method returning a fully qualified instance of this builder.109     * @param scriptTemplateResource external file resource holding script template code.110     * @return instance of this builder.111     */112    public static TemplateBasedScriptBuilder fromTemplateResource(Resource scriptTemplateResource) {113        try {114            return new TemplateBasedScriptBuilder(FileUtils.readToString(scriptTemplateResource.getInputStream()));115        } catch (IOException e) {116            throw new CitrusRuntimeException("Error loading script template from file resource", e);117        }118    }119}...

Source:TemplateBasedScriptBuilderTest.java

...20import com.consol.citrus.exceptions.CitrusRuntimeException;21/**22 * @author Christoph Deppisch23 */24public class TemplateBasedScriptBuilderTest {25    @Test26    public void testTemplateScriptData() {27        Assert.assertEquals(TemplateBasedScriptBuilder.fromTemplateScript("+++HEAD+++@SCRIPTBODY@+++TAIL+++")28                .withCode("BODY")29                .build(), "+++HEAD+++BODY+++TAIL+++");30    }31    32    @Test33    public void testTemplateScriptResource() {34        Assert.assertEquals(TemplateBasedScriptBuilder.fromTemplateResource(35                new ClassPathResource("com/consol/citrus/validation/script/script-template.groovy"))36                .withCode("BODY")37                .build(), "+++HEAD+++" + 38                System.getProperty("line.separator") + 39                System.getProperty("line.separator") + "BODY" + 40                System.getProperty("line.separator") + 41                System.getProperty("line.separator") + "+++TAIL+++");42    }43    44    @Test45    public void testMissingScriptBody() {46        Assert.assertEquals(TemplateBasedScriptBuilder.fromTemplateScript("+++HEAD+++@SCRIPTBODY@+++TAIL+++")47                .build(), "+++HEAD++++++TAIL+++");48    }49    50    @Test51    public void testInvalidScriptTemplate() {52        try {53            TemplateBasedScriptBuilder.fromTemplateScript("+++HEAD++++++TAIL+++")54                    .withCode("BODY")55                    .build();56        } catch (CitrusRuntimeException e) {57            Assert.assertTrue(e.getMessage().contains("@SCRIPTBODY@"));58            return;59        }60        61        Assert.fail("Missing error due to invalid script template");62    }63    64    @Test65    public void testCustomImports() {66        Assert.assertEquals(TemplateBasedScriptBuilder.fromTemplateScript("+++HEAD+++@SCRIPTBODY@+++TAIL+++")67                .withCode("import com.consol.citrus.MyClass;\n" +68                		"import com.consol.citrus.SomeOtherClass;\n" +69                		"importedBODYimported\n" +70                		"this is also script body\n\n" +71                		"END")72                .build(), "import com.consol.citrus.MyClass;\nimport com.consol.citrus.SomeOtherClass;\n" +73                		"+++HEAD+++importedBODYimported\nthis is also script body\n\nEND+++TAIL+++");74    }75}...

TemplateBasedScriptBuilder

Using AI Code Generation

1package com.consol.citrus.validation.script;2import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;3import org.testng.annotations.Test;4import java.util.HashMap;5import java.util.Map;6public class TemplateBasedScriptBuilderTest extends TestNGCitrusTestDesigner {7    public void TemplateBasedScriptBuilderTest() {8        variable("name", "John");9        variable("age", "30");10        variable("city", "New York");11        Map<String, Object> variables = new HashMap<>();12        variables.put("name", "John");13        variables.put("age", "30");14        variables.put("city", "New York");15        echo("Using variables");16        TemplateBasedScriptBuilder templateBasedScriptBuilder = new TemplateBasedScriptBuilder();17                .template("Hello ${name}, you are ${age} years old and live in ${city}.")18                .variables(variables);19        echo(templateBasedScriptBuilder.build());20        echo("Using variables");21        templateBasedScriptBuilder = new TemplateBasedScriptBuilder();22                .template("Hello ${name}, you are ${age} years old and live in ${city}.")23                .variables("name", "John", "age", "30", "city", "New York");24        echo(templateBasedScriptBuilder.build());25        echo("Using variables");26        templateBasedScriptBuilder = new TemplateBasedScriptBuilder();27                .template("Hello ${name}, you are ${age} years old and live in ${city}.")28                .variables("name", "John", "age", "30", "city", "New York");29        echo(templateBasedScriptBuilder.build());30        echo("Using variables");31        templateBasedScriptBuilder = new TemplateBasedScriptBuilder();32                .template("Hello ${name}, you are ${age} years old and live in ${city}.")33                .variables("name", "John", "age", "30", "city", "New York");34        echo(templateBasedScriptBuilder.build());35        echo("Using variables");36        templateBasedScriptBuilder = new TemplateBasedScriptBuilder();37                .template("Hello ${name}, you are ${age} years old and live in ${city}.")38                .variables("name", "John", "age", "30", "city", "New York");39        echo(template

TemplateBasedScriptBuilder

Using AI Code Generation

1import com.consol.citrus.dsl.builder.TemplateBasedScriptBuilder;2import com.consol.citrus.dsl.runner.TestRunner;3import com.consol.citrus.dsl.runner.TestRunners;4import com.consol.citrus.dsl.testng.TestNGCitrusTest;5import org.testng.annotations.Test;6public class TemplateBasedScriptBuilderTest extends TestNGCitrusTest {7    public void testTemplateBasedScriptBuilder() {8        TestRunner runner = TestRunners.testRunner();9        TemplateBasedScriptBuilder builder = new TemplateBasedScriptBuilder(runner, "classpath:templates/template1.txt");10        builder.variable("var1", "value1");11        builder.variable("var2", "value2");12        builder.execute();13    }14}15import com.consol.citrus.dsl.builder.TemplateBasedScriptBuilder;16import com.consol.citrus.dsl.runner.TestRunner;17import com.consol.citrus.dsl.runner.TestRunners;18import com.consol.citrus.dsl.testng.TestNGCitrusTest;19import org.testng.annotations.Test;20public class TemplateBasedScriptBuilderTest extends TestNGCitrusTest {21    public void testTemplateBasedScriptBuilder() {22        TestRunner runner = TestRunners.testRunner();23        TemplateBasedScriptBuilder builder = new TemplateBasedScriptBuilder(runner, "classpath:templates/template1.txt");24        builder.variable("var1", "value1");25        builder.variable("var2", "value2");26        builder.execute();27    }28}29import com.consol.citrus.dsl.builder.TemplateBasedScriptBuilder;30import com.consol.citrus.dsl.runner.TestRunner;31import com.consol.citrus.dsl.runner.TestRunners;32import com.consol.citrus.dsl.testng.TestNGCitrusTest;33import org.testng.annotations.Test;34public class TemplateBasedScriptBuilderTest extends TestNGCitrusTest {35    public void testTemplateBasedScriptBuilder() {

TemplateBasedScriptBuilder

Using AI Code Generation

1package com.consol.citrus.dsl.testng;2import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;3import com.consol.citrus.testng.CitrusParameters;4import org.testng.annotations.Test;5public class TemplateBasedScriptBuilderTest extends TestNGCitrusTestDesigner {6@CitrusParameters({"input"})7public void templateBasedScriptBuilder(String input) {8    variable("input", input);9    variable("output", "Hello Citrus!");10    echo("${input}");11    echo("${output}");12    echo("Test is finished");13    }14}15        <citrus:echo message="${input}" />16        <citrus:echo message="${output}" />

TemplateBasedScriptBuilder

Using AI Code Generation

1package com.consol.citrus.validation.script;2import org.testng.annotations.Test;3import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;4import com.consol.citrus.exceptions.ValidationException;5public class TemplateBasedScriptBuilderTest extends TestNGCitrusTestDesigner {6    public void templateBasedScriptBuilderTest() {7        variable("firstName", "John");8        variable("lastName", "Doe");9        variable("city", "New York");10        variable("street", "5th Avenue");11        variable("zipCode", "12345");12        echo("Use template based script builder to validate XML elements");13        run(templateBasedScriptBuilder()14                .templateResourcePath("classpath:com/consol/citrus/validation/script/4.xml")15                .templateVariables("${firstName}", "${lastName}", "${city}", "${street}", "${zipCode}"));16        echo("Use template based script builder to validate JSON elements");17        run(templateBasedScriptBuilder()18                .templateResourcePath("classpath:com/consol/citrus/validation/script/4.json")19                .templateVariables("${firstName}", "${lastName}", "${city}", "${street}", "${zipCode}"));20    }21    public void templateBasedScriptBuilderTestFail() {22        variable("firstName", "John");23        variable("lastName", "Doe");24        variable("city", "New York");25        variable("street", "5th Avenue");26        variable("zipCode", "12345");27        echo("Use template based script builder to validate XML elements");28        try {29            run(templateBasedScriptBuilder()30                    .templateResourcePath("classpath:com/consol/citrus/validation/script/4.xml")31                    .templateVariables("${firstName}", "${lastName}", "${city}", "${street}"));32        } catch (ValidationException e) {33            echo("Validation failed as expected: " + e.getMessage());34        }35        echo("Use template based script builder to validate JSON elements");36        try {37            run(templateBasedScriptBuilder()38                    .templateResourcePath("classpath:com/consol/citrus/validation/script/4.json")39                    .templateVariables("${firstName}", "${lastName}", "${city}", "${street}"));40        } catch (ValidationException e) {41            echo("Validation failed as expected: " + e.getMessage());42        }43    }44}

TemplateBasedScriptBuilder

Using AI Code Generation

1package com.consol.citrus.dsl.builder;2import com.consol.citrus.dsl.builder.AbstractTestContainerBuilder;3import com.consol.citrus.dsl.builder.ScriptValidationBuilder;4import com.consol.citrus.dsl.runner.TestRunner;5import java.util.Map;6public class ScriptValidationBuilder extends AbstractTestContainerBuilder<ScriptValidationBuilder> {7    private final com.consol.citrus.validation.script.ScriptValidationBuilder builder;8    public ScriptValidationBuilder(TestRunner runner, Map<String, Object> variables) {9        super(runner, variables);10        builder = new com.consol.citrus.validation.script.ScriptValidationBuilder();11    }12    public ScriptValidationBuilder script(String resourcePath) {13        builder.script(resourcePath);14        return this;15    }16    public ScriptValidationBuilder scriptResourcePath(String resourcePath) {17        builder.scriptResourcePath(resourcePath);18        return this;19    }20    public ScriptValidationBuilder scriptEngine(String scriptEngine) {21        builder.scriptEngine(scriptEngine);22        return this;23    }24    public ScriptValidationBuilder extractors(Map<String, String> extractors) {25        builder.extractors(extractors);26        return this;27    }28    public ScriptValidationBuilder extractor(String variable, String expression) {29        builder.extractor(variable, expression);30        return this;31    }32    public ScriptValidationBuilder extractors(String... extractors) {33        builder.extractors(extractors);34        return this;35    }36    public ScriptValidationBuilder extractors(Map

TemplateBasedScriptBuilder

Using AI Code Generation

1package com.consol.citrus.validation.script;2import java.util.HashMap;3import java.util.Map;4import org.testng.annotations.Test;5import com.consol.citrus.UnitTestSupport;6import com.consol.citrus.context.TestContext;7import com.consol.citrus.exceptions.CitrusRuntimeException;8import com.consol.citrus.message.Message;9import com.consol.citrus.message.MessageType;10import com.consol.citrus.validation.context.ValidationContext;11import com.consol.citrus.validation.script.json.JsonTextMessageScriptBuilder;12import com.consol.citrus.validation.script.xml.XmlMessageScriptBuilder;13public class TemplateBasedScriptBuilderTest extends UnitTestSupport {14public void testTemplateBasedScriptBuilder() {15Map<String, Object> variables = new HashMap<String, Object>();16variables.put("name", "John");17variables.put("age", "30");18TemplateBasedScriptBuilder scriptBuilder = new JsonTextMessageScriptBuilder("json-template.json", variables);19TestContext context = new TestContext();20Message message = new Message("{'name':'John','age':'30'}").type(MessageType.JSON);21ValidationContext validationContext = new ValidationContext();22scriptBuilder.buildScript(message, context, validationContext);23TemplateBasedScriptBuilder scriptBuilder1 = new XmlMessageScriptBuilder("xml-template.xml", variables);24scriptBuilder1.buildScript(message, context, validationContext);25TemplateBasedScriptBuilder scriptBuilder2 = new TemplateBasedScriptBuilder("json-template.json", variables);26scriptBuilder2.buildScript(message, context, validationContext);27TemplateBasedScriptBuilder scriptBuilder3 = new TemplateBasedScriptBuilder("xml-template.xml", variables);28scriptBuilder3.buildScript(message, context, validationContext);29TemplateBasedScriptBuilder scriptBuilder4 = new TemplateBasedScriptBuilder("txt-template.txt", variables);30scriptBuilder4.buildScript(message, context,

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.