gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.sdc.frontend.ci.tests.pages.component.workspace;
  21
  22 import com.aventstack.extentreports.Status;
  23 import com.google.gson.JsonObject;
  24 import com.google.gson.JsonParser;
  25 import java.time.Duration;
  26 import java.util.ArrayList;
  27 import java.util.HashSet;
  28 import java.util.Optional;
  29 import java.util.Random;
  30 import java.util.Set;
  31 import lombok.AllArgsConstructor;
  32 import lombok.Getter;
  33 import org.apache.commons.lang3.tuple.ImmutablePair;
  34 import org.onap.sdc.backend.ci.tests.datatypes.enums.UserRoleEnum;
  35 import org.onap.sdc.backend.ci.tests.utils.general.AtomicOperationUtils;
  36 import org.onap.sdc.frontend.ci.tests.datatypes.CanvasNodeElement;
  37 import org.onap.sdc.frontend.ci.tests.exception.CompositionCanvasRuntimeException;
  38 import org.onap.sdc.frontend.ci.tests.execute.setup.ExtentTestActions;
  39 import org.onap.sdc.frontend.ci.tests.pages.AbstractPageObject;
  40 import org.openecomp.sdc.be.model.ComponentInstance;
  41 import org.openecomp.sdc.be.model.Resource;
  42 import org.openecomp.sdc.be.model.Service;
  43 import org.openqa.selenium.Dimension;
  44 import org.openqa.selenium.JavascriptExecutor;
  45 import org.openqa.selenium.Point;
  46 import org.openqa.selenium.WebDriver;
  47 import org.openqa.selenium.WebElement;
  48 import org.openqa.selenium.interactions.Actions;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public class CompositionCanvasComponent extends AbstractPageObject {
  53
  54     private static final Logger LOGGER = LoggerFactory.getLogger(CompositionCanvasComponent.class);
  55     private static final String nodePositionJs = "var cy = window.jQuery('.sdc-composition-graph-wrapper').cytoscape('get');%n"
  56         + "var n = cy.nodes('[name=\"%s\"]');%n"
  57         + "var nPos = n.renderedPosition();%n"
  58         + "return JSON.stringify({%n"
  59         + "    x: nPos.x,%n"
  60         + "    y: nPos.y%n"
  61         + "})";
  62
  63     private static final String getNodesJs = "var cy = window.jQuery('.sdc-composition-graph-wrapper').cytoscape('get');\n"
  64         + "var nodes = [];"
  65         + "cy.nodes().forEach((node) => {nodes.push(JSON.stringify({name: node.data('name'), position: node.renderedPosition()}))});\n"
  66         + "return nodes;";
  67
  68     private final CompositionElementsComponent compositionElementsComponent;
  69     private final CompositionDetailSideBarComponent compositionDetailSideBarComponent;
  70
  71     private WebElement canvasWebElement;
  72     private Set<CanvasNodeElement> canvasElementList;
  73     private int canvasCenterX;
  74     private int canvasCenterY;
  75     private int canvasWidth;
  76     private int canvasHeight;
  77
  78     public CompositionCanvasComponent(final WebDriver webDriver) {
  79         super(webDriver);
  80         compositionElementsComponent = new CompositionElementsComponent(webDriver);
  81         compositionDetailSideBarComponent = new CompositionDetailSideBarComponent(webDriver);
  82     }
  83
  84     @Override
  85     public void isLoaded() {
  86         //waiting the canvas data to be load and animation finishes.
  87         new Actions(webDriver).pause(Duration.ofSeconds(2)).perform();
  88         canvasWebElement = waitToBeClickable(XpathSelector.CANVAS_ELEMENT.getXpath());
  89         compositionElementsComponent.isLoaded();
  90         compositionDetailSideBarComponent.isLoaded();
  91         loadCanvas();
  92         loadElements();
  93     }
  94
  95     private void loadCanvas() {
  96         canvasWidth = canvasWebElement.getSize().getWidth();
  97         canvasHeight = canvasWebElement.getSize().getHeight();
  98         canvasCenterX = canvasWidth / 2;
  99         canvasCenterY = canvasHeight / 2;
 100         LOGGER.debug("Canvas with size [{}, {}] and center [{}, {}]", canvasWidth, canvasHeight, canvasCenterX, canvasCenterY);
 101         final String scriptJS = "var cy = window.jQuery('.sdc-composition-graph-wrapper').cytoscape('get');\n"
 102             + "return JSON.stringify({width: cy.width(), height: cy.height()});";
 103         final Object sizeObj = ((JavascriptExecutor) webDriver).executeScript(scriptJS);
 104         final JsonObject size = new JsonParser().parse(sizeObj.toString()).getAsJsonObject();
 105
 106         LOGGER.debug("Canvas with size [{}, {}]", size.get("width"), size.get("height"));
 107     }
 108
 109     private void loadElements() {
 110         canvasElementList = new HashSet<>();
 111         final Object nodeListObj = ((JavascriptExecutor) webDriver).executeScript(getNodesJs);
 112         if (!(nodeListObj instanceof ArrayList)) {
 113             return;
 114         }
 115         final ArrayList<String> nodeList = (ArrayList<String>) nodeListObj;
 116         if (nodeList.isEmpty()) {
 117             return;
 118         }
 119         nodeList.forEach(nodeString -> {
 120             final JsonObject node = new JsonParser().parse(nodeString).getAsJsonObject();
 121             final JsonObject position = node.get("position").getAsJsonObject();
 122             final CanvasNodeElement canvasElement =
 123                 new CanvasNodeElement(node.get("name").getAsString(), position.get("x").getAsInt(), position.get("y").getAsInt());
 124             canvasElementList.add(canvasElement);
 125         });
 126     }
 127
 128     public void selectNode(final String elementName) {
 129         final Optional<CanvasNodeElement> canvasElementOptional = canvasElementList.stream()
 130             .filter(canvasNodeElement -> canvasNodeElement.getName().equals(elementName))
 131             .findFirst();
 132         if (canvasElementOptional.isEmpty()) {
 133             throw new CompositionCanvasRuntimeException(String.format("Given element '%s' does not exist on the element list", elementName));
 134         }
 135         final CanvasNodeElement canvasNodeElement = canvasElementOptional.get();
 136         final Point positionFromCenter = calculateOffsetFromCenter(canvasNodeElement.getPositionX(),
 137             canvasNodeElement.getPositionY());
 138         final Actions actions = new Actions(webDriver);
 139         int offsetFromElementCenter = 10;
 140         actions.moveToElement(canvasWebElement, positionFromCenter.getX() - offsetFromElementCenter,
 141             positionFromCenter.getY() + offsetFromElementCenter)
 142             .pause(Duration.ofSeconds(1))
 143             .click()
 144             .perform();
 145         ExtentTestActions.takeScreenshot(Status.INFO, "canvas-node-selected", String.format("'%s' was selected", elementName));
 146     }
 147
 148     public ComponentInstance createNodeOnServiceCanvas(final String serviceName, final String serviceVersion, final String resourceName,
 149                                                        final String resourceVersion) {
 150         final Point freePositionInCanvas = getFreePositionInCanvas(20);
 151         final Point pointFromCanvasCenter = calculateOffsetFromCenter(freePositionInCanvas);
 152         try {
 153             final Service service =
 154                 AtomicOperationUtils.getServiceObjectByNameAndVersion(UserRoleEnum.DESIGNER, serviceName, serviceVersion);
 155             final Resource resourceToAdd =
 156                 AtomicOperationUtils.getResourceObjectByNameAndVersion(UserRoleEnum.DESIGNER, resourceName, resourceVersion);
 157             final ComponentInstance componentInstance = AtomicOperationUtils
 158                 .addComponentInstanceToComponentContainer(resourceToAdd, service, UserRoleEnum.DESIGNER, true,
 159                     String.valueOf(pointFromCanvasCenter.getX()), String.valueOf(pointFromCanvasCenter.getY()))
 160                 .left().value();
 161
 162             LOGGER.debug("Created instance {} in the Service {}", componentInstance.getName(), serviceName);
 163             return componentInstance;
 164         } catch (final Exception e) {
 165             throw new CompositionCanvasRuntimeException("Could not create node through the API", e);
 166         }
 167     }
 168
 169     private Point getFreePositionInCanvas(int maxAttempts) {
 170         boolean isPositionFree;
 171         final int minSpace = 150;
 172         for (int attemptCount = 0; attemptCount < maxAttempts; attemptCount++) {
 173             final Point randomPositionInCanvas = getRandomPositionInCanvas();
 174             isPositionFree = canvasElementList.stream()
 175                 .noneMatch(canvasNodeElement -> Math.abs(canvasNodeElement.getPositionX() - randomPositionInCanvas.getX()) < minSpace
 176                     && Math.abs(canvasNodeElement.getPositionX() - randomPositionInCanvas.getY()) < minSpace);
 177             if (isPositionFree) {
 178                 return randomPositionInCanvas;
 179             }
 180         }
 181         throw new CompositionCanvasRuntimeException("Could not find a free Canvas position");
 182     }
 183
 184     private Point getRandomPositionInCanvas() {
 185         final Random random = new Random();
 186         int x = random.nextInt(canvasWidth);
 187         final int maxAllowedWidth = canvasWidth - getRightMarginWidth();
 188         final int minAllowedWidth = 30;
 189         if (x > maxAllowedWidth) {
 190             x = x - getRightMarginWidth();
 191         } else if (x < minAllowedWidth) {
 192             x = x + minAllowedWidth;
 193         }
 194         int bottomMargin = 0;
 195         int heightTopMargin = 100;
 196         int y = random.nextInt(canvasHeight);
 197         int maxAllowedHeight = canvasHeight - bottomMargin;
 198
 199         if (y > maxAllowedHeight) {
 200             y = y - bottomMargin;
 201         } else if (y < heightTopMargin) {
 202             y = y + heightTopMargin;
 203         }
 204         LOGGER.debug("Generated random position in canvas [{},{}]", x, y);
 205
 206         return new Point(x, y);
 207     }
 208
 209     private int getRightMarginWidth() {
 210         int canvasIconsOffset = 100;
 211         final Dimension sideBarSize = compositionDetailSideBarComponent.getSize();
 212         return sideBarSize.getWidth() + canvasIconsOffset;
 213     }
 214
 215     private Point calculateOffsetFromCenter(final Point point) {
 216         return calculateOffsetFromCenter(point.getX(), point.getY());
 217     }
 218
 219     private Point calculateOffsetFromCenter(final int xPosition, final int yPosition) {
 220         final int positionX = xPosition - canvasCenterX;
 221         final int positionY = yPosition - canvasCenterY;
 222         return new Point(positionX, positionY);
 223     }
 224
 225     public ImmutablePair<Integer, Integer> getElementPositionByName(final String elementName) {
 226         final String scriptJs = String.format(nodePositionJs, elementName);
 227         final Object position = ((JavascriptExecutor) webDriver).executeScript(scriptJs);
 228         final JsonObject positionAsJson = new JsonParser().parse(position.toString()).getAsJsonObject();
 229         int xElement = positionAsJson.get("x").getAsInt();
 230         int yElement = positionAsJson.get("y").getAsInt();
 231         return new ImmutablePair<>(xElement, yElement);
 232     }
 233
 234     /**
 235      * Enum that contains identifiers and xpath expressions to elements related to the enclosing page object.
 236      */
 237     @AllArgsConstructor
 238     private enum XpathSelector {
 239         CANVAS_ELEMENT("canvas", "//*[@data-tests-id='%s']//canvas[1]");
 240
 241         @Getter
 242         private final String id;
 243         private final String xpathFormat;
 244
 245         public String getXpath() {
 246             return String.format(xpathFormat, id);
 247         }
 248     }
 249 }