Merge pull request #107 from polycube-network/pr/port_simple_services_to_base_class

services: port simple services to new code generation schema

Author: frisso

src/services/pcn-helloworld/src/CMakeLists.txt

@@ -2,7 +2,7 @@ include(${PROJECT_SOURCE_DIR}/cmake/LoadFileAsVariable.cmake)
 
 aux_source_directory(serializer SERIALIZER_SOURCES)
 aux_source_directory(api API_SOURCES)
-aux_source_directory(default-src SRC_SOURCES)
+aux_source_directory(base BASE_SOURCES)
 
 include_directories(serializer)
 include_directories(interface)
@@ -14,7 +14,7 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR})
 add_library(pcn-helloworld SHARED
   ${SERIALIZER_SOURCES}
   ${API_SOURCES}
-  ${SRC_SOURCES}
+  ${BASE_SOURCES}
   Helloworld.cpp
   Ports.cpp
   Helloworld-lib.cpp)

src/services/pcn-helloworld/src/Helloworld.cpp

@@ -25,17 +25,10 @@
 using namespace polycube::service;
 
 Helloworld::Helloworld(const std::string name, const HelloworldJsonObject &conf)
-    : Cube(conf.getBase(), {helloworld_code_ingress}, {}) {
-  logger()->set_pattern("[%Y-%m-%d %H:%M:%S.%e] [helloworld] [%n] [%l] %v");
-  logger()->info("Creating helloworld instance");
-
-  // TODO: action should have a default value, so the actionIsSet control could
-  // be ommitted.
-  if (conf.actionIsSet()) {
-    setAction(conf.getAction());
-  } else {
-    setAction(HelloworldActionEnum::DROP);
-  }
+    : Cube(conf.getBase(), {helloworld_code_ingress}, {}),
+      HelloworldBase(name) {
+  logger()->info("Creating Helloworld instance");
+  setAction(conf.getAction());
 
   // set an initial state before doing any change to the configuration
   // UINT16_MAX means that the port is not connected
@@ -47,41 +40,7 @@ Helloworld::Helloworld(const std::string name, const HelloworldJsonObject &conf)
 }
 
 Helloworld::~Helloworld() {
-  logger()->info("destroying helloworld instance");
-}
-
-void Helloworld::update(const HelloworldJsonObject &conf) {
-  // This method updates all the object/parameter in Helloworld object specified
-  // in the conf JsonObject.
-  // You can modify this implementation.
-
-  // update base cube implementation
-  Cube::set_conf(conf.getBase());
-
-  if (conf.actionIsSet()) {
-    setAction(conf.getAction());
-  }
-
-  if (conf.portsIsSet()) {
-    for (auto &i : conf.getPorts()) {
-      auto name = i.getName();
-      auto m = getPorts(name);
-      m->update(i);
-    }
-  }
-}
-
-HelloworldJsonObject Helloworld::toJsonObject() {
-  HelloworldJsonObject conf;
-  conf.setBase(Cube::to_json());
-
-  conf.setAction(getAction());
-
-  for (auto &i : getPortsList()) {
-    conf.addPorts(i->toJsonObject());
-  }
-
-  return conf;
+  logger()->info("Destroying Helloworld instance");
 }
 
 void Helloworld::packet_in(Ports &port, polycube::service::PacketInMetadata &md,
@@ -99,14 +58,6 @@ void Helloworld::setAction(const HelloworldActionEnum &value) {
   get_array_table<uint8_t>("action_map").set(0x0, action);
 }
 
-std::shared_ptr<Ports> Helloworld::getPorts(const std::string &name) {
-  return get_port(name);
-}
-
-std::vector<std::shared_ptr<Ports>> Helloworld::getPortsList() {
-  return get_ports();
-}
-
 void Helloworld::addPorts(const std::string &name,
                           const PortsJsonObject &conf) {
   if (get_ports().size() == 2) {
@@ -135,20 +86,6 @@ void Helloworld::addPorts(const std::string &name,
   ports_table.set(port_map_index, p->index());
 }
 
-void Helloworld::addPortsList(const std::vector<PortsJsonObject> &conf) {
-  for (auto &i : conf) {
-    std::string name_ = i.getName();
-    addPorts(name_, i);
-  }
-}
-
-void Helloworld::replacePorts(const std::string &name,
-                              const PortsJsonObject &conf) {
-  delPorts(name);
-  std::string name_ = conf.getName();
-  addPorts(name_, conf);
-}
-
 void Helloworld::delPorts(const std::string &name) {
   int index = get_port(name)->index();
 
@@ -165,10 +102,3 @@ void Helloworld::delPorts(const std::string &name) {
   remove_port(name);
   logger()->info("port {0} was removed", name);
 }
-
-void Helloworld::delPortsList() {
-  auto ports = get_ports();
-  for (auto it : ports) {
-    delPorts(it->name());
-  }
-}

src/services/pcn-helloworld/src/Helloworld.h

@@ -16,47 +16,29 @@
 
 #pragma once
 
-#include "../interface/HelloworldInterface.h"
-
-#include "polycube/services/cube.h"
-#include "polycube/services/port.h"
-#include "polycube/services/utils.h"
-
-#include <spdlog/spdlog.h>
+#include "../base/HelloworldBase.h"
 
 #include "Ports.h"
 
-using namespace io::swagger::server::model;
-
-class Helloworld : public polycube::service::Cube<Ports>,
-                   public HelloworldInterface {
-  friend class Ports;
+using namespace polycube::service::model;
 
+class Helloworld : public HelloworldBase {
  public:
   Helloworld(const std::string name, const HelloworldJsonObject &conf);
   virtual ~Helloworld();
+
   void packet_in(Ports &port, polycube::service::PacketInMetadata &md,
                  const std::vector<uint8_t> &packet) override;
 
-  void update(const HelloworldJsonObject &conf) override;
-  HelloworldJsonObject toJsonObject() override;
-
-  /// <summary>
-  /// Action performed on the received packet (i.e., DROP, SLOWPATH, or FORWARD;
-  /// default: DROP)
-  /// </summary>
-  HelloworldActionEnum getAction() override;
-  void setAction(const HelloworldActionEnum &value) override;
-
   /// <summary>
   /// Entry of the ports table
   /// </summary>
-  std::shared_ptr<Ports> getPorts(const std::string &name) override;
-  std::vector<std::shared_ptr<Ports>> getPortsList() override;
   void addPorts(const std::string &name, const PortsJsonObject &conf) override;
-  void addPortsList(const std::vector<PortsJsonObject> &conf) override;
-  void replacePorts(const std::string &name,
-                    const PortsJsonObject &conf) override;
   void delPorts(const std::string &name) override;
-  void delPortsList() override;
+
+  /// <summary>
+  /// Action performed on the received packet (i.e., DROP, SLOWPATH, or FORWARD; default: DROP)
+  /// </summary>
+  HelloworldActionEnum getAction() override;
+  void setAction(const HelloworldActionEnum &value) override;
 };

src/services/pcn-helloworld/src/Ports.cpp

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-// Modify these methods with your own implementation
-
 #include "Ports.h"
 #include "Helloworld.h"
 
@@ -24,26 +22,6 @@ using namespace polycube::service;
 Ports::Ports(polycube::service::Cube<Ports> &parent,
              std::shared_ptr<polycube::service::PortIface> port,
              const PortsJsonObject &conf)
-    : Port(port), parent_(static_cast<Helloworld &>(parent)) {
-  logger()->info("Creating Ports instance");
-}
+    : PortsBase(parent, port) {}
 
 Ports::~Ports() {}
-
-void Ports::update(const PortsJsonObject &conf) {
-  Port::set_conf(conf.getBase());
-  // This method updates all the object/parameter in Ports object specified in
-  // the conf JsonObject.
-  // You can modify this implementation.
-}
-
-PortsJsonObject Ports::toJsonObject() {
-  PortsJsonObject conf;
-  conf.setBase(Port::to_json());
-
-  return conf;
-}
-
-std::shared_ptr<spdlog::logger> Ports::logger() {
-  return parent_.logger();
-}

src/services/pcn-helloworld/src/Ports.h

@@ -14,34 +14,19 @@
  * limitations under the License.
  */
 
-#pragma once
-
-#include "../interface/PortsInterface.h"
-
-#include "polycube/services/cube.h"
-#include "polycube/services/port.h"
-#include "polycube/services/utils.h"
 
-#include <spdlog/spdlog.h>
+#pragma once
 
-#include <memory>
+#include "../base/PortsBase.h"
 
 class Helloworld;
-// class PortIface;
 
-using namespace io::swagger::server::model;
+using namespace polycube::service::model;
 
-class Ports : public polycube::service::Port, public PortsInterface {
+class Ports : public PortsBase {
  public:
   Ports(polycube::service::Cube<Ports> &parent,
-        std::shared_ptr<polycube::service::PortIface> port,
-        const PortsJsonObject &conf);
+      std::shared_ptr<polycube::service::PortIface> port,
+      const PortsJsonObject &conf);
   virtual ~Ports();
-
-  std::shared_ptr<spdlog::logger> logger();
-  void update(const PortsJsonObject &conf) override;
-  PortsJsonObject toJsonObject() override;
-
- private:
-  Helloworld &parent_;
 };

src/services/pcn-helloworld/src/api/HelloworldApi.cpp

@@ -1,12 +1,8 @@
 /**
-* helloworld API
 * helloworld API generated from helloworld.yang
 *
-* OpenAPI spec version: 1.0.0
-*
-* NOTE: This class is auto generated by the swagger code generator program.
-* https://github.com/polycube-network/swagger-codegen.git
-* branch polycube
+* NOTE: This file is auto generated by polycube-codegen
+* https://github.com/polycube-network/polycube-codegen
 */
 
 
@@ -16,8 +12,8 @@
 #include "HelloworldApi.h"
 #include "HelloworldApiImpl.h"
 
-using namespace io::swagger::server::model;
-using namespace io::swagger::server::api::HelloworldApiImpl;
+using namespace polycube::service::model;
+using namespace polycube::service::api::HelloworldApiImpl;
 
 #ifdef __cplusplus
 extern "C" {

src/services/pcn-helloworld/src/api/HelloworldApi.h

@@ -1,12 +1,8 @@
 /**
-* helloworld API
 * helloworld API generated from helloworld.yang
 *
-* OpenAPI spec version: 1.0.0
-*
-* NOTE: This class is auto generated by the swagger code generator program.
-* https://github.com/polycube-network/swagger-codegen.git
-* branch polycube
+* NOTE: This file is auto generated by polycube-codegen
+* https://github.com/polycube-network/polycube-codegen
 */
 
 

src/services/pcn-helloworld/src/api/HelloworldApiImpl.cpp

@@ -1,12 +1,8 @@
 /**
-* helloworld API
 * helloworld API generated from helloworld.yang
 *
-* OpenAPI spec version: 1.0.0
-*
-* NOTE: This class is auto generated by the swagger code generator program.
-* https://github.com/polycube-network/swagger-codegen.git
-* branch polycube
+* NOTE: This file is auto generated by polycube-codegen
+* https://github.com/polycube-network/polycube-codegen
 */
 
 
@@ -15,12 +11,11 @@
 
 #include "HelloworldApiImpl.h"
 
-namespace io {
-namespace swagger {
-namespace server {
+namespace polycube {
+namespace service {
 namespace api {
 
-using namespace io::swagger::server::model;
+using namespace polycube::service::model;
 
 namespace HelloworldApiImpl {
 namespace {
@@ -380,5 +375,4 @@ std::vector<nlohmann::fifo_map<std::string, std::string>> read_helloworld_ports_
 }
 }
 }
-}
 

src/services/pcn-helloworld/src/api/HelloworldApiImpl.h

@@ -1,12 +1,8 @@
 /**
-* helloworld API
 * helloworld API generated from helloworld.yang
 *
-* OpenAPI spec version: 1.0.0
-*
-* NOTE: This class is auto generated by the swagger code generator program.
-* https://github.com/polycube-network/swagger-codegen.git
-* branch polycube
+* NOTE: This file is auto generated by polycube-codegen
+* https://github.com/polycube-network/polycube-codegen
 */
 
 
@@ -30,12 +26,11 @@
 #include "PortsJsonObject.h"
 #include <vector>
 
-namespace io {
-namespace swagger {
-namespace server {
+namespace polycube {
+namespace service {
 namespace api {
 
-using namespace io::swagger::server::model;
+using namespace polycube::service::model;
 
 namespace HelloworldApiImpl {
   void create_helloworld_by_id(const std::string &name, const HelloworldJsonObject &value);
@@ -66,5 +61,4 @@ namespace HelloworldApiImpl {
 }
 }
 }
-}