Merge branch '8-handwrite-a-some-ip-adapter' into 'master'

Resolve "Handwrite a Some/IP-Adapter"

Closes #8

See merge request !1

.gitignore

+/target/
+/bin/
+.settings
+.project
+.classpath

.gitlab-ci.yml

+stages:
+- linux
+
+BranchJobLinux:
+  stage: linux
+  image: registry.git.rwth-aachen.de/monticore/embeddedmontiarc/generators/emam2someip
+  script:
+  - mvn clean install -s settings.xml
+  except:
+  - master

README.md

 # EMAM2SomeIP
 
+### Install SOME/IP:
+
+Get vsomeip from: https://github.com/GENIVI/vsomeip
+
+Build instruction is in the readme on the site, short summary:
+- A C++11 enabled compiler like gcc >= 4.8 is needed.
+- vsomeip uses CMake as buildsystem.
+- vsomeip uses Boost (boost.org), version has to be >= 1.55 and < 1.66:
+
+#### Linux:
+
+Installing boost 1.65 on ubuntu 18.10:
+```bash
+sudo apt-get install libboost-system1.65-dev libboost-thread1.65-dev libboost-log1.65-dev
+```
+Build vsomeip from vsomeip main directory:
+```bash
+mkdir build
+cd build
+sudo cmake ..
+sudo make
+sudo make install
+```
+
+If build fails, try to apply this fix:
+
+https://github.com/GENIVI/vsomeip/issues/25
+
+Summary of the fix: 
+Replace "return &sockaddr;" with "return reinterpret_cast<struct sockaddr*>(&sockaddr);" 
+in the file: implementation/endpoints/include/netlink_connector.hpp
+
+##### Build the documentation:
+
+To build the documentation asciidoc, source-highlight, doxygen and graphviz is needed:
+```bash
+sudo apt-get install asciidoc source-highlight doxygen graphviz
+make doc
+```
+
+#### Windows:
+
+- get cmake: https://cmake.org/download/
+- get boost (e.g. v.1.65): https://www.boost.org/doc/libs/1_65_0/more/getting_started/windows.html 
+- use cmake and visual studio to build vsomeip

docker/Dockerfile

+# Use an official Python runtime as a parent image
+FROM ubuntu:16.04
+
+RUN apt-get update
+
+RUN apt-get -y install build-essential 
+
+RUN apt-get -y install cmake 
+
+RUN apt-get -y install libboost-system1.58-dev libboost-thread1.58-dev libboost-log1.58-dev
+
+RUN apt-get update \
+    && apt-get -y install openjdk-8-jdk \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64
+
+ENV PATH $JAVA_HOME/bin:$PATH
+
+RUN apt-get update
+
+RUN apt-get -y install maven
+
+RUN apt-get -y install git
+
+RUN mkdir /usr/src/emam2someip
+
+WORKDIR /usr/src/emam2someip
+
+RUN git clone https://github.com/GENIVI/vsomeip.git
+
+#copy example
+COPY . /usr/src/emam2someip
+
+WORKDIR /usr/src/emam2someip/vsomeip
+
+RUN mkdir /usr/src/emam2someip/vsomeip/build
+
+WORKDIR /usr/src/emam2someip/vsomeip/build
+
+RUN cmake ..
+
+RUN make
+
+RUN make install
+
+WORKDIR /usr/src/emam2someip/vsomeip
+
+RUN rm -rf build
+
+WORKDIR /usr/src/emam2someip/example/build
+
+RUN cmake ..
+
+RUN make
+
+

docker/example/CMakeLists.txt

+cmake_minimum_required (VERSION 2.8)
+
+set (CMAKE_CXX_FLAGS "-g -std=c++0x")
+
+find_package (vsomeip 2.10.0 REQUIRED)
+find_package( Boost 1.55 COMPONENTS system thread log REQUIRED )
+
+include_directories (
+    ${Boost_INCLUDE_DIR}
+    ${VSOMEIP_INCLUDE_DIRS}
+)
+
+add_executable(service-example ../src/service-example.cpp)
+target_link_libraries(service-example vsomeip ${Boost_LIBRARIES})
+add_executable(client-example ../src/client-example.cpp)
+target_link_libraries(client-example vsomeip ${Boost_LIBRARIES})
+

docker/example/src/client-example.cpp

+#include <iomanip>
+#include <iostream>
+#include <sstream>
+
+#include <condition_variable>
+#include <thread>
+
+#include <vsomeip/vsomeip.hpp>
+
+#define SAMPLE_SERVICE_ID 0x1234
+#define SAMPLE_INSTANCE_ID 0x5678
+#define SAMPLE_METHOD_ID 0x0421
+
+std::shared_ptr< vsomeip::application > app;
+std::mutex mutex;
+std::condition_variable condition;
+
+void run() {
+  std::unique_lock<std::mutex> its_lock(mutex);
+  condition.wait(its_lock);
+
+  std::shared_ptr< vsomeip::message > request;
+  request = vsomeip::runtime::get()->create_request();
+  request->set_service(SAMPLE_SERVICE_ID);
+  request->set_instance(SAMPLE_INSTANCE_ID);
+  request->set_method(SAMPLE_METHOD_ID);
+  
+  double d = 2.5;
+  uint8_t *byteArray = (uint8_t*)&d;
+  
+  vsomeip::byte_t *p;
+  p = byteArray; 
+  
+  std::shared_ptr< vsomeip::payload > its_payload = vsomeip::runtime::get()->create_payload(p,8);
+  request->set_payload(its_payload);
+  app->send(request, true);
+}
+
+void on_message(const std::shared_ptr<vsomeip::message> &_response) {
+
+  std::shared_ptr<vsomeip::payload> its_payload = _response->get_payload();
+  vsomeip::length_t l = its_payload->get_length();
+
+  // Get payload
+  std::stringstream ss;
+  for (vsomeip::length_t i=0; i<l; i++) {
+     ss << std::setw(2) << std::setfill('0') << std::hex
+        << (int)*(its_payload->get_data()+i) << " ";
+  }
+
+  std::cout << "CLIENT: Received message with Client/Session ["
+      << std::setw(4) << std::setfill('0') << std::hex << _response->get_client() << "/"
+      << std::setw(4) << std::setfill('0') << std::hex << _response->get_session() << "] "
+      << ss.str() << std::endl;
+}
+
+void on_availability(vsomeip::service_t _service, vsomeip::instance_t _instance, bool _is_available) {
+    std::cout << "CLIENT: Service ["
+            << std::setw(4) << std::setfill('0') << std::hex << _service << "." << _instance
+            << "] is "
+            << (_is_available ? "available." : "NOT available.")
+            << std::endl;
+    condition.notify_one();
+}
+
+int main() {
+
+    app = vsomeip::runtime::get()->create_application("Subscriber");
+    app->init();
+    app->register_availability_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, on_availability);
+    app->request_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
+    app->register_message_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_METHOD_ID, on_message);
+    std::thread sender(run);
+    app->start();
+}

docker/example/src/service-example.cpp

+#include <iomanip>
+#include <iostream>
+#include <sstream>
+
+#include <vsomeip/vsomeip.hpp>
+
+#define SAMPLE_SERVICE_ID 0x1234
+#define SAMPLE_INSTANCE_ID 0x5678
+#define SAMPLE_METHOD_ID 0x0421
+
+std::shared_ptr<vsomeip::application> app;
+
+void on_message(const std::shared_ptr<vsomeip::message> &_request) {
+
+    std::shared_ptr<vsomeip::payload> its_payload = _request->get_payload();
+    vsomeip::length_t l = its_payload->get_length();
+    
+    double final = *((double*)its_payload->get_data());
+
+    std::cout << "SERVICE: Received message with Client/Session ["
+        << std::setw(4) << std::setfill('0') << std::hex << _request->get_client() << "/"
+        << std::setw(4) << std::setfill('0') << std::hex << _request->get_session() << "]: "
+        << final << std::endl;
+}
+
+int main() {
+
+   app = vsomeip::runtime::get()->create_application("Publisher");
+   app->init();
+   app->register_message_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_METHOD_ID, on_message);
+   app->offer_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
+   app->start();
+}

pom.xml

+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>emam2someipgroup</groupId>
+  <artifactId>emam2someip</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <name>emam2someip</name>
+  
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.source>1.7</maven.compiler.source>
+    <maven.compiler.target>1.7</maven.compiler.target>
+
+    <!-- .. SE-Libraries .................................................. -->
+    <se-commons.version>1.7.7</se-commons.version>
+    <Embedded-MontiArc-Math.version>0.1.7-SNAPSHOT</Embedded-MontiArc-Math.version>
+    <Embedded-montiarc-math-rosmsg-generator.version>0.1.3-SNAPSHOT</Embedded-montiarc-math-rosmsg-generator.version>
+
+    <!-- .. Libraries .................................................. -->
+    <guava.version>18.0</guava.version>
+    <junit.version>4.12</junit.version>
+    <logback.version>1.1.2</logback.version>
+
+    <!-- .. Plugins ....................................................... -->
+    <assembly.plugin>2.5.4</assembly.plugin>
+    <compiler.plugin>3.3</compiler.plugin>
+    <source.plugin>2.4</source.plugin>
+    <shade.plugin>2.4.3</shade.plugin>
+    <jacoco.plugin>0.8.1</jacoco.plugin>
+
+    <!-- Classifiers -->
+    <grammars.classifier>grammars</grammars.classifier>
+    <cli.classifier>cli</cli.classifier>
+
+    <!-- .. Misc .......................................................... -->
+    <java.version>1.8</java.version>
+
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    <github.global.server>github</github.global.server>
+  </properties>
+
+  <dependencies>
+
+    <dependency>
+      <groupId>de.se_rwth.commons</groupId>
+      <artifactId>se-commons-logging</artifactId>
+      <version>${se-commons.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>de.monticore.lang.monticar</groupId>
+      <artifactId>embedded-montiarc-math-rosmsg-generator</artifactId>
+      <version>${Embedded-montiarc-math-rosmsg-generator.version}</version>
+    </dependency>
+
+    <!-- MontiCore Dependencies -->
+
+    <dependency>
+      <groupId>de.se_rwth.commons</groupId>
+      <artifactId>se-commons-groovy</artifactId>
+      <version>${se-commons.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>de.monticore.lang.monticar</groupId>
+      <artifactId>embedded-montiarc-math</artifactId>
+      <version>${Embedded-MontiArc-Math.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>de.monticore.lang.monticar</groupId>
+      <artifactId>embedded-montiarc-math</artifactId>
+      <version>${Embedded-MontiArc-Math.version}</version>
+      <classifier>${grammars.classifier}</classifier>
+      <scope>provided</scope>
+    </dependency>
+
+
+    <!-- .. Test Libraries ............................................... -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>${junit.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>${logback.version}</version>
+    </dependency>
+
+  </dependencies>
+
+
+  <!-- == PROJECT BUILD SETTINGS =========================================== -->
+
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-deploy-plugin</artifactId>
+        <version>2.8.1</version>
+      </plugin>
+
+      <!-- Other Configuration -->
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>${compiler.plugin}</version>
+        <configuration>
+          <useIncrementalCompilation>true</useIncrementalCompilation>
+          <source>${java.version}</source>
+          <target>${java.version}</target>
+        </configuration>
+      </plugin>
+      
+      <!-- Test coverage -->
+      <plugin>
+          <groupId>org.jacoco</groupId>
+          <artifactId>jacoco-maven-plugin</artifactId>
+          <version>${jacoco.plugin}</version>
+          <executions>
+              <execution>
+                  <id>pre-unit-test</id>
+                  <goals>
+                      <goal>prepare-agent</goal>
+                  </goals>
+              </execution>
+              <execution>
+                  <id>post-unit-test</id>
+                  <phase>test</phase>
+                  <goals>
+                      <goal>report</goal>
+                  </goals>
+              </execution>
+          </executions>
+      </plugin>
+
+      <!-- Source Jar Configuration -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>${source.plugin}</version>
+        <executions>
+          <execution>
+            <id>create source jar</id>
+            <phase>package</phase>
+            <goals>
+              <goal>jar-no-fork</goal>
+            </goals>
+            <configuration>
+              <excludeResources>false</excludeResources>
+              <includes>
+                <include>**/*.java</include>
+                <include>**/*.ftl</include>
+              </includes>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>2.19.1</version>
+        <configuration>
+          <useSystemClassLoader>false</useSystemClassLoader>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.eluder.coveralls</groupId>
+        <artifactId>coveralls-maven-plugin</artifactId>
+        <version>4.3.0</version>
+        <configuration>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>cobertura-maven-plugin</artifactId>
+        <version>2.7</version>
+        <configuration>
+          <format>xml</format>
+          <maxmem>256m</maxmem>
+          <!-- aggregated reports for multi-module projects -->
+          <aggregate>true</aggregate>
+          <check/>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+
+  <distributionManagement>
+    <repository>
+      <id>se-nexus</id>
+      <url>https://nexus.se.rwth-aachen.de/content/repositories/embeddedmontiarc-releases/</url>
+    </repository>
+    <snapshotRepository>
+      <id>se-nexus</id>
+      <url>https://nexus.se.rwth-aachen.de/content/repositories/embeddedmontiarc-snapshots/</url>
+    </snapshotRepository>
+  </distributionManagement>
+  
+</project>

settings.xml

+<?xml version="1.0" encoding="UTF-8"?>
+
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+  <pluginGroups>
+	<pluginGroup>org.mortbay.jetty</pluginGroup>
+	<pluginGroup>de.topobyte</pluginGroup>
+  </pluginGroups>
+
+  <proxies>
+  </proxies>
+
+  <servers>
+    <server>
+      <id>se-nexus</id>
+      <username>cibuild</username>
+      <password>${env.cibuild}</password>
+    </server> 
+
+     <server>
+      <id>github</id>
+      <username>travisbuilduser</username>
+      <password>${env.travisbuilduserpassword}</password>
+    </server>
+  </servers>
+
+  <mirrors>
+    <mirror>
+      <id>se-nexus</id>
+      <mirrorOf>external:*</mirrorOf>
+      <url>https://nexus.se.rwth-aachen.de/content/groups/public</url>
+    </mirror>	 
+  </mirrors>
+
+  <profiles>
+    <profile>
+      <id>sonar</id>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <properties>
+        <!-- Optional URL to server. Default value is http://localhost:9000 -->
+        <sonar.host.url>
+          https://metric.se.rwth-aachen.de
+        </sonar.host.url>
+        <sonar.login>
+		      jenkins
+		    </sonar.login>
+		    <sonar.password>
+		      ${env.sonar}
+		    </sonar.password>
+      </properties>
+    </profile>
+
+    <profile>
+      <id>se-nexus</id>
+      <repositories>
+        <repository>
+          <id>central</id>
+          <url>http://central</url>
+          <releases><enabled /></releases>
+          <snapshots><enabled /></snapshots>
+        </repository>
+      </repositories>
+      <pluginRepositories>
+        <pluginRepository>
+          <id>central</id>
+          <url>http://central</url>
+          <releases><enabled /></releases>
+          <snapshots><enabled /></snapshots>
+        </pluginRepository>
+      </pluginRepositories>
+    </profile>
+  </profiles>
+
+  <activeProfiles>
+    <activeProfile>se-nexus</activeProfile>
+  </activeProfiles>  
+</settings>

someip_adapter/CMakeLists.txt

+# Setting cmake version
+cmake_minimum_required (VERSION 3.12)
+
+# Using C++ version 11 with threads for compiling
+set (CMAKE_CXX_FLAGS "-g -std=c++0x")
+
+# Setting project name and description
+project(SomeipAdapter VERSION 1.0
+                  DESCRIPTION "Someip adapter"
+                  LANGUAGES CXX)
+
+# Find packages and include directories
+find_package (vsomeip 2.10.0 REQUIRED)
+find_package( Boost 1.55 COMPONENTS system thread log REQUIRED )
+
+include_directories (
+    ${Boost_INCLUDE_DIR}
+    ${VSOMEIP_INCLUDE_DIRS}
+)
+
+# Linking libraries to target
+add_library(SomeipAdapter_tests_a_compA SomeipAdapter_tests_a_compA.cpp)
+target_link_libraries(SomeipAdapter_tests_a_compA vsomeip ${Boost_LIBRARIES})
+
+# Export target to a cmake module file for outside usage
+export(TARGETS SomeipAdapter_tests_a_compA FILE SomeipAdapter_tests_a_compA.cmake)

someip_adapter/SomeipAdapter_tests_a_compA.cpp

+#include "SomeipAdapter_tests_a_compA.h"
+
+#define SAMPLE_SERVICE_ID 0x1234
+#define SAMPLE_INSTANCE_ID 0x5678
+#define SAMPLE_METHOD_ID 0x0421
+#define SAMPLE_EVENT_ID 0x2345
+#define SAMPLE_EVENTGROUP_ID 0x1456
+
+std::shared_ptr<vsomeip::application> _clockSubscriber;
+
+std::shared_ptr<vsomeip::application> _echoPublisher;
+
+SomeipAdapter_tests_a_compA::SomeipAdapter_tests_a_compA() {}
+
+void SomeipAdapter_tests_a_compA::init(tests_a_compA *comp)
+{
+    _clockSubscriber = vsomeip::runtime::get()->create_application("Subscriber");
+    _clockSubscriber->init();
+    _clockSubscriber->register_availability_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, on_availability);
+    _clockSubscriber->request_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
+
+    _clockSubscriber->register_message_handler(vsomeip::ANY_SERVICE, vsomeip::ANY_INSTANCE, vsomeip::ANY_METHOD, on_message);
+
+  	std::unique_lock<std::mutex> its_lock(mutex);
+	
+  	std::set<vsomeip::eventgroup_t> its_groups;
+  	its_groups.insert(SAMPLE_EVENTGROUP_ID);
+  	_clockSubscriber->request_event(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_groups, true);
+  	_clockSubscriber->subscribe(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENTGROUP_ID);
+    _clockSubscriber->start();
+    
+}
+
+void SomeipAdapter_tests_a_compA::on_message(const std::shared_ptr<vsomeip::message> &_request) {
+
+    std::shared_ptr<vsomeip::payload> its_payload = _request->get_payload();
+    vsomeip::length_t l = its_payload->get_length();
+    
+    double final = *((double*)its_payload->get_data());
+
+    std::cout << "SERVICE: Received message with Client/Session ["
+        << std::setw(4) << std::setfill('0') << std::hex << _request->get_client() << "/"
+        << std::setw(4) << std::setfill('0') << std::hex << _request->get_session() << "]: "
+        << final << std::endl;
+}
+
+void SomeipAdapter_tests_a_compA::on_availability(vsomeip::service_t _service, vsomeip::instance_t _instance, bool _is_available) {
+    std::cout << "CLIENT: Service ["
+            << std::setw(4) << std::setfill('0') << std::hex << _service << "." << _instance
+            << "] is "
+            << (_is_available ? "available." : "NOT available.")
+            << std::endl;
+}
+
+void SomeipAdapter_tests_a_compA::publish_echoPublisher()
+{
+   _echoPublisher = vsomeip::runtime::get()->create_application("Publisher");
+   _echoPublisher->init();
+   //app->register_message_handler(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_METHOD_ID, on_message);
+    
+   double d = 2.5;
+   uint8_t *byteArray = (uint8_t*)&d;
+  
+   vsomeip::byte_t *p;
+   p = byteArray; 
+  
+   std::shared_ptr< vsomeip::payload > its_payload = vsomeip::runtime::get()->create_payload(p,8);
+	
+   std::set<vsomeip::eventgroup_t> its_groups;
+   its_groups.insert(SAMPLE_EVENTGROUP_ID);
+   _echoPublisher->offer_event(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_groups, true);
+   _echoPublisher->notify(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID, SAMPLE_EVENT_ID, its_payload);
+   _echoPublisher->offer_service(SAMPLE_SERVICE_ID, SAMPLE_INSTANCE_ID);
+   _echoPublisher->start();
+}
+
+void SomeipAdapter_tests_a_compA::tick()
+{
+    publish_echoPublisher();
+}