How to use ObjectSpecs class of com.galenframework.specs.page package

...21import com.galenframework.speclang2.pagespec.rules.Rule;22import com.galenframework.parser.Expectations;23import com.galenframework.parser.StructNode;24import com.galenframework.specs.Spec;25import com.galenframework.specs.page.ObjectSpecs;26import com.galenframework.specs.Place;27import org.apache.commons.lang3.tuple.ImmutablePair;28import org.apache.commons.lang3.tuple.Pair;29import java.io.IOException;30import java.util.*;31import java.util.regex.Matcher;32public class PageSectionProcessor {33    public static final String NO_OBJECT_NAME = null;34    private final PageSpecHandler pageSpecHandler;35    private final PageSection parentSection;36    public PageSectionProcessor(PageSpecHandler pageSpecHandler) {37        this.pageSpecHandler = pageSpecHandler;38        this.parentSection = null;39    }40    public PageSectionProcessor(PageSpecHandler pageSpecHandler, PageSection parentSection) {41        this.pageSpecHandler = pageSpecHandler;42        this.parentSection = parentSection;43    }44    public void process(StructNode sectionNode) throws IOException {45        if (sectionNode.getChildNodes() != null) {46            String sectionName = sectionNode.getName().substring(1, sectionNode.getName().length() - 1).trim();47            PageSection section = findSection(sectionName);48            if (section == null) {49                section = new PageSection(sectionName, sectionNode.getPlace());50                if (parentSection != null) {51                    parentSection.addSubSection(section);52                } else {53                    pageSpecHandler.addSection(section);54                }55            }56            processSection(section, sectionNode.getChildNodes());57        }58    }59    private void processSection(PageSection section, List<StructNode> childNodes) throws IOException {60        for (StructNode sectionChildNode : childNodes) {61            String childPlace = sectionChildNode.getName();62            if (isSectionDefinition(childPlace)) {63                new PageSectionProcessor(pageSpecHandler, section).process(sectionChildNode);64            } else if (isRule(childPlace)) {65                processSectionRule(section, sectionChildNode);66            } else if (isObject(childPlace)) {67                processObject(section, sectionChildNode);68            } else {69                throw new SyntaxException(sectionChildNode, "Unknown statement: " + childPlace);70            }71        }72    }73    private void processSectionRule(PageSection section, StructNode ruleNode) throws IOException {74        String ruleText = ruleNode.getName().substring(1).trim();75        Pair<PageRule, Map<String, String>> rule = findAndProcessRule(ruleText, ruleNode);76        PageSection ruleSection = new PageSection(ruleText, ruleNode.getPlace());77        section.addSubSection(ruleSection);78        List<StructNode> resultingNodes;79        try {80            resultingNodes = rule.getKey().apply(pageSpecHandler, ruleText, NO_OBJECT_NAME, rule.getValue(), ruleNode.getChildNodes());81            processSection(ruleSection, resultingNodes);82        } catch (Exception ex) {83            throw new SyntaxException(ruleNode, "Error processing rule: " + ruleText, ex);84        }85    }86    private Pair<PageRule, Map<String, String>> findAndProcessRule(String ruleText, StructNode ruleNode) {87        ListIterator<Pair<Rule, PageRule>> iterator = pageSpecHandler.getPageRules().listIterator(pageSpecHandler.getPageRules().size());88        /*89        It is important to make a reversed iteration over all rules so that90        it is possible for the end user to override previously defined rules91         */92        while (iterator.hasPrevious()) {93            Pair<Rule, PageRule> rulePair = iterator.previous();94            Matcher matcher = rulePair.getKey().getPattern().matcher(ruleText);95            if (matcher.matches()) {96                int index = 1;97                Map<String, String> parameters = new HashMap<>();98                for (String parameterName : rulePair.getKey().getParameters()) {99                    String value = matcher.group(index);100                    pageSpecHandler.setGlobalVariable(parameterName, value, ruleNode);101                    parameters.put(parameterName, value);102                    index += 1;103                }104                return new ImmutablePair<>(rulePair.getValue(), parameters);105            }106        }107        throw new SyntaxException(ruleNode, "Couldn't find rule matching: " + ruleText);108    }109    private void processObjectLevelRule(ObjectSpecs objectSpecs, StructNode sourceNode) throws IOException {110        String ruleText = sourceNode.getName().substring(1).trim();111        Pair<PageRule, Map<String, String>> rule = findAndProcessRule(ruleText, sourceNode);112        try {113            pageSpecHandler.setGlobalVariable("objectName", objectSpecs.getObjectName(), sourceNode);114            List<StructNode> specNodes = rule.getKey().apply(pageSpecHandler, ruleText, objectSpecs.getObjectName(), rule.getValue(), sourceNode.getChildNodes());115            SpecGroup specGroup = new SpecGroup();116            specGroup.setName(ruleText);117            objectSpecs.addSpecGroup(specGroup);118            for (StructNode specNode : specNodes) {119                specGroup.addSpec(pageSpecHandler.getSpecReader().read(specNode.getName(), pageSpecHandler.getContextPath()));120            }121        } catch (Exception ex) {122            throw new SyntaxException(sourceNode, "Error processing rule: " + ruleText, ex);123        }124    }125    private boolean isRule(String nodeText) {126        return nodeText.startsWith("|");127    }128    private PageSection findSection(String sectionName) {129        if (parentSection != null) {130            return findSection(sectionName, parentSection.getSections());131        } else {132            return findSection(sectionName, pageSpecHandler.getPageSections());133        }134    }135    private PageSection findSection(String sectionName, List<PageSection> sections) {136        for (PageSection section : sections) {137            if (section.getName().equals(sectionName)) {138                return section;139            }140        }141        return null;142    }143    private void processObject(PageSection section, StructNode objectNode) throws IOException {144        String name = objectNode.getName();145        String objectExpression = name.substring(0, name.length() - 1).trim();146        List<String> objectNames = pageSpecHandler.findAllObjectsMatchingStrictStatements(objectExpression);147        for (String objectName : objectNames) {148            if (objectNode.getChildNodes() != null && objectNode.getChildNodes().size() > 0) {149                ObjectSpecs objectSpecs = findObjectSpecsInSection(section, objectName);150                if (objectSpecs == null) {151                    objectSpecs = new ObjectSpecs(objectName);152                    section.addObjects(objectSpecs);153                }154                for (StructNode specNode : objectNode.getChildNodes()) {155                    if (isRule(specNode.getName())) {156                        processObjectLevelRule(objectSpecs, specNode);157                    } else {158                        processSpec(objectSpecs, specNode);159                    }160                }161            }162        }163    }164    private void processSpec(ObjectSpecs objectSpecs, StructNode specNode) {165        if (specNode.getChildNodes() != null && !specNode.getChildNodes().isEmpty()) {166            throw new SyntaxException(specNode, "Specs cannot have inner blocks");167        }168        String specText = specNode.getName();169        boolean onlyWarn = false;170        if (specText.startsWith("%")) {171            specText = specText.substring(1);172            onlyWarn = true;173        }174        String alias = null;175        StringCharReader reader = new StringCharReader(specText);176        if (reader.firstNonWhiteSpaceSymbol() == '"') {177            alias = Expectations.doubleQuotedText().read(reader);178            specText = reader.getTheRest();179        }180        Spec spec;181        try {182            spec = pageSpecHandler.getSpecReader().read(specText, pageSpecHandler.getContextPath());183        } catch (SyntaxException ex) {184            ex.setPlace(specNode.getPlace());185            throw ex;186        }187        spec.setOnlyWarn(onlyWarn);188        spec.setAlias(alias);189        if (specNode.getPlace() != null) {190            spec.setPlace(new Place(specNode.getPlace().getFilePath(), specNode.getPlace().getLineNumber()));191        }192        spec.setProperties(pageSpecHandler.getProperties());193        spec.setJsVariables(pageSpecHandler.getJsVariables());194        objectSpecs.getSpecs().add(spec);195    }196    private ObjectSpecs findObjectSpecsInSection(PageSection section, String objectName) {197        if (section.getObjects() != null) {198            for (ObjectSpecs objectSpecs : section.getObjects()) {199                if (objectSpecs.getObjectName().equals(objectName)) {200                    return objectSpecs;201                }202            }203        }204        return null;205    }206    private boolean isObject(String childPlace) {207        return childPlace.endsWith(":");208    }209    public static boolean isSectionDefinition(String name) {210        return name.startsWith("=") && name.endsWith("=");211    }212}...

...14* limitations under the License.15******************************************************************************/16package com.galenframework.components.specs;17import com.galenframework.specs.Spec;18import com.galenframework.specs.page.ObjectSpecs;19import com.galenframework.specs.page.PageSection;20import com.galenframework.specs.page.SpecGroup;21import com.galenframework.specs.Spec;22import com.galenframework.specs.page.ObjectSpecs;23import com.galenframework.specs.page.PageSection;24import com.galenframework.specs.page.SpecGroup;25import org.apache.commons.lang3.builder.EqualsBuilder;26import org.apache.commons.lang3.builder.HashCodeBuilder;27import org.apache.commons.lang3.builder.ToStringBuilder;28import java.util.HashMap;29import java.util.LinkedList;30import java.util.List;31import java.util.Map;32import static java.util.Arrays.asList;33public class ExpectedSpecObject {34    private String expectedName;35    private List<String> specs = new LinkedList<>();36    private Map<String, List<String>> specGroups = new HashMap<>();37    public ExpectedSpecObject(String expectedName) {38        this.expectedName = expectedName;39    }40    public ExpectedSpecObject withSpecs(String...specs) {41        this.specs = asList(specs);42        return this;43    }44    public List<String> getSpecs() {45        return specs;46    }47    public static List<ExpectedSpecObject> convertSection(PageSection pageSection) {48        List<ExpectedSpecObject> objects = new LinkedList<>();49        for (ObjectSpecs objectSpecs : pageSection.getObjects()) {50            ExpectedSpecObject object = convertExpectedSpecObject(objectSpecs);51            objects.add(object);52        }53        return objects;54    }55    private static ExpectedSpecObject convertExpectedSpecObject(ObjectSpecs objectSpecs) {56        ExpectedSpecObject object = new ExpectedSpecObject(objectSpecs.getObjectName());57        List<String> specs = convertSpecs(objectSpecs.getSpecs());58        object.setSpecs(specs);59        Map<String, List<String>> specGroups = new HashMap<String, List<String>>();60        for (SpecGroup specGroup : objectSpecs.getSpecGroups()) {61            specGroups.put(specGroup.getName(), convertSpecs(specGroup.getSpecs()));62        }63        object.setSpecGroups(specGroups);64        return object;65    }66    private static List<String> convertSpecs(List<Spec> originalSpecs) {67        List<String> specs = new LinkedList<>();68        for (Spec spec : originalSpecs) {69            specs.add(spec.getOriginalText());...

...22import org.apache.commons.lang3.StringUtils;23import com.galenframework.specs.Spec;24import com.galenframework.specs.page.CorrectionsRect;25import com.galenframework.specs.page.Locator;26import com.galenframework.specs.page.ObjectSpecs;27import com.galenframework.specs.page.PageSection;28import com.galenframework.specs.page.PageSpec;29import io.wcm.qa.glnm.configuration.GaleniumConfiguration;30import io.wcm.qa.glnm.exceptions.GaleniumException;31import io.wcm.qa.glnm.selectors.base.Selector;32/**33 * Factory class to get image comparing Galen specs.34 *35 * @since 2.0.036 */37final class IcsFactory {38  private IcsFactory() {39  }40  /**41   * <p>getPageSpec.</p>42   *43   * @param def parameters for spec generation44   * @return a parsed Galen page spec45   */46  static PageSpec getPageSpec(IcsDefinition def) {47    checkSanity(def);48    // specs49    Spec spec = IcUtil.getSpecForText(IcUtil.getImageComparisonSpecText(def));50    ObjectSpecs objectSpecs = new ObjectSpecs(def.getElementName());51    Spec insideViewportSpec = IcUtil.getSpecForText("inside viewport");52    objectSpecs.addSpec(insideViewportSpec);53    objectSpecs.addSpec(spec);54    if (GaleniumConfiguration.isSamplingVerificationIgnore()) {55      spec.setOnlyWarn(true);56      insideViewportSpec.setOnlyWarn(true);57    }58    if (def.isZeroToleranceWarning()) {59      Spec zeroToleranceSpec = IcUtil.getSpecForText(IcUtil.getZeroToleranceImageComparisonSpecText(def));60      zeroToleranceSpec.setOnlyWarn(true);61      objectSpecs.addSpec(zeroToleranceSpec);62    }63    // page section64    PageSection pageSection = new PageSection(def.getSectionName());...

1import com.galenframework.specs.page.ObjectSpecs;2import com.galenframework.specs.page.PageSpec;3import com.galenframework.validation.ValidationResult;4import com.galenframework.validation.ValidationListener;5import com.galenframework.validation.ValidationObject;6import com.galenframework.validation.ValidationResult.ValidationError;7import com.galenframework.validation.ValidationResult.ValidationObjectResult;8import com.galenframework.validation.ValidationResult.ValidationPageResult;9import com.galenframework.validation.ValidationResult.ValidationError.ErrorLevel;10public class GalenTest {11    public static void main(String[] args) throws Exception {12        ObjectSpecs objectSpecs = new ObjectSpecs();13        objectSpecs.add("main-menu", "width", "100px");14        objectSpecs.add("main-menu", "height", "100px");15        PageSpec pageSpec = new PageSpec();16        pageSpec.addObject("main-menu", objectSpecs);17        ValidationListener validationListener = new ValidationListener() {18            public void onObjectValidation(ValidationObject validationObject, ValidationObjectResult validationObjectResult) {19                for (ValidationError error : validationObjectResult.getErrors()) {20                    System.out.println(error.getMessage());21                }22            }23            public void onPageValidation(ValidationPageResult validationPageResult) {24                for (ValidationError error : validationPageResult.getErrors()) {25                    System.out.println(error.getMessage());26                }27            }28        };29        if (validationResult.errors() > 0) {30            throw new RuntimeException("There are " + validationResult.errors() + " errors");31        }32    }33}

1package com.galenframework.specs.page;2import com.galenframework.specs.Spec;3import com.galenframework.specs.SpecHidden;4import com.galenframework.specs.SpecVisible;5import com.galenframework.specs.page.Locator;6import com.galenframework.specs.page.ObjectSpec;7import java.util.LinkedList;8import java.util.List;9public class ObjectSpecs {10    private List<ObjectSpec> objectSpecs = new LinkedList();11    public ObjectSpecs() {12    }13    public ObjectSpecs(ObjectSpec objectSpec) {14        this.objectSpecs.add(objectSpec);15    }16    public List<ObjectSpec> getObjectSpecs() {17        return this.objectSpecs;18    }19    public ObjectSpecs with(ObjectSpec objectSpec) {20        this.objectSpecs.add(objectSpec);21        return this;22    }23    public ObjectSpecs with(String objectName, Spec spec) {24        this.objectSpecs.add(new ObjectSpec(objectName, spec));25        return this;26    }27    public ObjectSpecs with(String objectName, Locator locator, Spec spec) {28        this.objectSpecs.add(new ObjectSpec(objectName, locator, spec));29        return this;30    }31    public ObjectSpecs visible(String objectName) {32        this.objectSpecs.add(new ObjectSpec(objectName, new SpecVisible()));33        return this;34    }35    public ObjectSpecs hidden(String objectName) {36        this.objectSpecs.add(new ObjectSpec(objectName, new SpecHidden()));37        return this;38    }39    public ObjectSpecs visible(String objectName, Locator locator) {40        this.objectSpecs.add(new ObjectSpec(objectName, locator, new SpecVisible()));41        return this;42    }43    public ObjectSpecs hidden(String objectName, Locator locator) {44        this.objectSpecs.add(new ObjectSpec(objectName, locator, new SpecHidden()));45        return this;46    }47}48package com.galenframework.specs.page;49import com.galenframework.specs.page.ObjectSpecs;50import java.util.LinkedList;51import java.util.List;52public class ObjectSpecs {53    private List<ObjectSpec> objectSpecs = new LinkedList();54    public ObjectSpecs() {55    }56    public ObjectSpecs(ObjectSpec objectSpec) {57        this.objectSpecs.add(objectSpec);58    }

1package com.galenframework.specs.page;2import com.galenframework.specs.Spec;3import com.galenframework.specs.SpecHidden;4import com.galenframework.specs.SpecText;5import com.galenframework.specs.SpecVisible;6import com.galenframework.specs.page.Locator;7import com.galenframework.specs.page.PageSpec;8import com.galenframework.specs.page.PageSection;9import com.galenframework.specs.page.PageSectionSpec;10import com.galenframework.specs.page.PageSpec;11import com.galenframework.specs.page.PageSection;12import

1import com.galenframework.specs.page.ObjectSpecs;2import java.util.List;3import java.util.ArrayList;4import org.openqa.selenium.By;5import org.openqa.selenium.WebDriver;6import org.openqa.selenium.WebElement;7import org.openqa.selenium.chrome.ChromeDriver;8import org.openqa.selenium.chrome.ChromeOptions;9import org.openqa.selenium.support.ui.ExpectedConditions;10import org.openqa.selenium.support.ui.WebDriverWait;11import java.io.IOException;12import java.util.concurrent.TimeUnit;13import org.testng.annotations.*;14import org.testng.Assert;15import org.testng.annotations.Test;16import com.galenframework.api.Galen;17import com.galenframework.reports.GalenTestInfo;18import com.galenframewo

1public class ObjectSpecs {2    public static void main(String[] args) throws IOException {3        ObjectSpecs objectSpecs = new ObjectSpecs();4        objectSpecs.objectSpecs();5    }6    public void objectSpecs() throws IOException {7        ObjectSpecs objectSpecs = new ObjectSpecs();8        objectSpecs.objectSpecs();9        SpecReader specReader = new SpecReader();

1import com.galenframework.specs.page.ObjectSpecs;2import com.galenframework.specs.page.PageSpec;3import com.galenframework.specs.page.PageSpecs;4import com.galenframework.specs.page.PageSpecsBuilder;5import com.galenframework.specs.page.PageSpecsBuilder.ObjectSpecsBuilder;6import org.openqa.selenium.WebDriver;7import org.openqa.selenium.WebElement;8import org.openqa.selenium.support.FindBy;9import org.openqa.selenium.support.How;10import org.openqa.selenium.support.PageFactory;11import org.openqa.selenium.support.ui.ExpectedConditions;12import org.openqa.selenium.support.ui.WebDriverWait;13public class PageObject {14    private final WebDriver driver;15    private final WebDriverWait wait;16    private WebElement newButton;17    private WebElement nameField;18    private WebElement accountNumberField;19    private WebElement phoneNumberField;20    private WebElement websiteField;21    private WebElement faxField;

1package com.galenframework.specs.page;2import java.util.ArrayList;3import java.util.List;4import com.galenframework.specs.Spec;5import com.galenframework.specs.SpecFactory;6import com.galenframework.specs.SpecMissing;7public class ObjectSpecs {8    private List<Spec> specs = new ArrayList<>();9    public ObjectSpecs(List<Spec> specs) {10        this.specs = specs;11    }12    public ObjectSpecs() {}13    public List<Spec> getSpecs() {14        return specs;15    }16    public void setSpecs(List<Spec> specs) {17        this.specs = specs;18    }19    public void addSpec(Spec spec) {20        this.specs.add(spec);21    }22    public static ObjectSpecs merge(ObjectSpecs first, ObjectSpecs second) {23        ObjectSpecs mergedSpecs = new ObjectSpecs();24        if (first != null) {25            mergedSpecs.getSpecs().addAll(first.getSpecs());26        }27        if (second != null) {28            mergedSpecs.getSpecs().addAll(second.getSpecs());29        }30        return mergedSpecs;31    }32    public static ObjectSpecs fromSpecs(List<Spec> specs) {33        return new ObjectSpecs(specs);34    }35    public static ObjectSpecs fromSpecs(Spec... specs) {36        ObjectSpecs objectSpecs = new ObjectSpecs();37        for (Spec spec : specs) {38            objectSpecs.getSpecs().add(spec);39        }40        return objectSpecs;41    }42    public static ObjectSpecs fromString(String string) {43        ObjectSpecs objectSpecs = new ObjectSpecs();44        for (String specString : string.split(",")) {45            Spec spec = SpecFactory.parse(specString.trim());46            if (spec != null) {47                objectSpecs.addSpec(spec);48            }49        }50        return objectSpecs;51    }52    public static ObjectSpecs fromString(String string, String defaultSpecs) {53        if (string != null) {54            return fromString(string);55        }56        else {57            return fromString(defaultSpecs);58        }59    }60    public static ObjectSpecs missing() {61        ObjectSpecs objectSpecs = new ObjectSpecs();62        objectSpecs.addSpec(new SpecMissing());63        return objectSpecs;

1package com.galenframework.specs.page;2import java.util.ArrayList;3import java.util.List;4public class ObjectSpecs {5    private final List<ObjectSpec> objects = new ArrayList<>();6    public ObjectSpecs add(String name, String type, String... tags) {7        objects.add(new ObjectSpec(name, type, tags));8        return this;9    }10    public List<ObjectSpec> getObjects() {11        return objects;12    }13}14package com.galenframework.specs.page;15public class ObjectSpec {16    private String name;17    private String type;18    private String[] tags;19    public ObjectSpec(String name, String type, String... tags) {20        this.name = name;21        this.type = type;22        this.tags = tags;23    }24    public String getName() {25        return name;26    }27    public String getType() {28        return type;29    }30    public String[] getTags() {31        return tags;32    }33}34package com.galenframework.specs.page;35import java.util.ArrayList;36import java.util.List;37public class ObjectSpecs {38    private final List<ObjectSpec> objects = new ArrayList<>();39    public ObjectSpecs add(String name, String type, String... tags) {40        objects.add(new ObjectSpec(name, type, tags));41        return this;42    }43    public List<ObjectSpec> getObjects() {44        return objects;45    }46}47package com.galenframework.specs.page;48public class ObjectSpec {49    private String name;50    private String type;51    private String[] tags;52    public ObjectSpec(String name, String type, String... tags) {53        this.name = name;54        this.type = type;55        this.tags = tags;56    }57    public String getName() {58        return name;59    }60    public String getType() {61        return type;62    }