Controller Config class at Cisco rest Driver

Change-Id: Ie5b91484da1eb75fe13afa9a1ce72de62d39b398

drivers/cisco/rest/src/main/java/org/onosproject/drivers/cisco/rest/ControllerConfigCiscoImpl.java

@@ -0,0 +1,125 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.onosproject.drivers.cisco.rest;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+import java.io.IOException;;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
+import org.onosproject.drivers.cisco.rest.NxApiRequest.CommandType;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.behaviour.ControllerConfig;
+import org.onosproject.net.behaviour.ControllerInfo;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.net.driver.DriverHandler;
+import org.slf4j.Logger;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+/**
+ * Gets and Sets the openflow controller.
+ */
+public class ControllerConfigCiscoImpl extends AbstractHandlerBehaviour implements ControllerConfig {
+    private final Logger log = getLogger(getClass());
+
+    private static final String SHOW_OF_CONTROLLER_CMD = "show openflow switch 1 controllers";
+    private static final String OPENFLOW_CMD = "openflow";
+    private static final String SW1_CMD = "switch 1";
+    private static final String DELETE_OF_CONFIG = "no switch 1";
+    private static final String PROTO_VER_CMD = "protocol-version 1.3";
+    private static final String PIPELINE_CMD = "pipeline 201";
+    private static final String OF_CONTROLLER_CONF_CMD = "controller ipv4 %s port %d vrf %s security none";
+    private static final String NO_SHUTDOWN_CMD = "no shutdown";
+    private static final String COPY_RUNNING_CONFIG = "copy running-config startup-config";
+
+    @Override
+    public List<ControllerInfo> getControllers() {
+        List<ControllerInfo> controllers = new ArrayList<ControllerInfo>();
+        DeviceId deviceId = handler().data().deviceId();
+
+        String response;
+
+            // "show openflow switch 1 controller" command only shows outputs with cli_ascii command type
+            response = NxApiRequest.post(handler(), SHOW_OF_CONTROLLER_CMD, CommandType.CLI_ASCII);
+
+        if (response == null) {
+            log.error("Failed to perform {} command on the device {} Response has Error/null",
+                    SHOW_OF_CONTROLLER_CMD, deviceId);
+            return controllers;
+        }
+
+        try {
+            ObjectMapper om = new ObjectMapper();
+            JsonNode json = om.readTree(response);
+            if (json.has("result")) {
+                JsonNode res = json.get("result");
+                String msg = res.findValue("msg").asText();
+            } else if (json.has("error")) {
+                log.error("{} Response has IllegalStateException Error/null", deviceId);
+                return controllers;
+            }
+        } catch (IOException e) {
+            log.error("Exception thrown", e);
+        }
+
+        return controllers;
+    }
+
+    @Override
+    public void setControllers(List<ControllerInfo> controllers) {
+        DriverHandler handler = handler();
+        DeviceId deviceId = handler.data().deviceId();
+
+        List<String> cmds = new ArrayList<>();
+        cmds.add(OPENFLOW_CMD);
+        cmds.add(DELETE_OF_CONFIG);
+        cmds.add(SW1_CMD);
+        cmds.add(PROTO_VER_CMD);
+        cmds.add(PIPELINE_CMD);
+
+        // can configure up to eight controllers
+        controllers.stream().limit(8).forEach(c -> cmds
+                .add(String.format(OF_CONTROLLER_CONF_CMD, c.ip().toString(), c.port(), "management")));
+        cmds.add(NO_SHUTDOWN_CMD);
+        cmds.add(COPY_RUNNING_CONFIG);
+        String response = NxApiRequest.postClis(handler, cmds);
+        if (Objects.isNull(response)) {
+            throw new NullPointerException("Response is null");
+        }
+
+        if (response != null) {
+            try {
+                ObjectMapper om = new ObjectMapper();
+                JsonNode json = om.readTree(response);
+                //TODO parse error messages.
+                if (json.has("error")) {
+                    log.error("{} Response has IllegalStateException Error", deviceId);
+                    return;
+                }
+            } catch (IOException e) {
+                log.error("Exception thrown", e);
+            }
+        } else {
+            log.error("Can't reach the deviceId {}", deviceId);
+        }
+    }
+
+}

drivers/cisco/rest/src/main/java/org/onosproject/drivers/cisco/rest/NxApiRequest.java

@@ -23,6 +23,7 @@ import java.util.List;
 import java.util.stream.IntStream;
 
 import org.onosproject.net.DeviceId;
+import org.onosproject.net.driver.DriverHandler;
 import org.onosproject.protocol.rest.RestSBController;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -30,6 +31,8 @@ import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
 import javax.ws.rs.core.MediaType;
+import com.google.common.collect.Lists;
+import static com.google.common.base.Preconditions.checkNotNull;
 
 /**
  * Generate json-rpc request for Cisco NX-API.
@@ -63,6 +66,10 @@ public final class NxApiRequest {
     private NxApiRequest() {
     }
 
+    public static String generate(String command, CommandType type) {
+        return generate(Lists.newArrayList(command), type);
+    }
+
     /**
      * Generates a NX-API request message to execute on the Cisco NXOS device.
      * @param commands list of commands to execute
@@ -117,4 +124,34 @@ public final class NxApiRequest {
 
         return response;
     }
+
+    /**
+     * Sends NX-API request message to the device.
+     * @param handler device's driver handler
+     * @param command NX-API command string
+     * @param type response message format
+     * @return the response string
+     */
+    public static String post(DriverHandler handler, String command, CommandType type) {
+        RestSBController controller = checkNotNull(handler.get(RestSBController.class));
+        DeviceId deviceId = handler.data().deviceId();
+
+        String request = generate(command, type);
+        return post(controller, deviceId, request);
+    }
+
+    /**
+     * Sends NX-API request message to the device.
+     * @param handler device's driver handler
+     * @param cmds NX-API list of command strings
+     * @return the response string
+     */
+    static String postClis(DriverHandler handler, List<String> cmds) {
+        RestSBController controller = checkNotNull(handler.get(RestSBController.class));
+        DeviceId deviceId = handler.data().deviceId();
+
+        String request = generate(cmds, CommandType.CLI);
+        InputStream stream = new ByteArrayInputStream(request.getBytes(StandardCharsets.UTF_8));
+        return controller.post(deviceId, API_URI, stream, MediaType.valueOf(APP_JSON_RPC), String.class);
+    }
 }

drivers/cisco/rest/src/main/resources/cisco-rest-drivers.xml

@@ -20,5 +20,7 @@
                    impl="org.onosproject.drivers.cisco.rest.CiscoNxosDeviceDescription"/>
         <behaviour api="org.onosproject.net.device.PortStatisticsDiscovery"
                    impl="org.onosproject.drivers.cisco.rest.CiscoNxosPortStatistics"/>
+        <behaviour api="org.onosproject.net.behaviour.ControllerConfig"
+                   impl="org.onosproject.drivers.cisco.rest.ControllerConfigCiscoImpl"/>
     </driver>
 </drivers>