Add RIOT federated CoAP TEST (#189)

* WIP

* WIP

* Use tmux

* Fix

* Create tap interfaces

* Add env variables

* Read out termination code and print to tmp

* Switch to static ipv6 addresses for the riot coap example

* Remove ip from build.sh

* Cleanup and migrate test to static ip

* msg_t -> lf_msg_t

* Finish test

* Add tmux

* Fix ci

* Fix CI

* Fix

* Remove tmux

* Add tapsetup

* Add sudo

* Fix

* Make riotbuild container priviliged

* Test

* Fix

* Improve description

* msg_t -> lf_msg_t

* Move ip configuration to makefile

* Cleanup makefiles

---------

Co-authored-by: erlingrj <[email protected]>

Author: LasseRosenow

.github/actions/riot/action.yml

@@ -17,3 +17,11 @@ runs:
         cd ${{env.RIOTBASE}}
         git checkout ${{env.RIOT_COMMIT_ID}}
       shell: bash
+
+    - name: Setup tap interfaces
+      run: |
+        apt update
+        apt install -y --no-install-recommends iproute2 sudo
+        sudo $RIOTBASE/dist/tools/tapsetup/tapsetup
+        ip a
+      shell: bash

.github/workflows/riot.yml

@@ -9,6 +9,7 @@ jobs:
     runs-on: ubuntu-24.04
     container:
       image: riot/riotbuild:latest
+      options: --privileged
     env:
       RIOT_COMMIT_ID: "cb5500b4b7600d95f42a3070abae402be4f63845"
       RIOTBASE: "/opt/riot-cb5500b4b7600d95f42a3070abae402be4f63845"
@@ -25,10 +26,10 @@ jobs:
       - name: Install LFC dependencies
         uses: ./.github/actions/lingua-franca
 
-      - name: Build examples
-        working-directory: ${{ github.workspace }}/examples/riot
-        run: ./buildAll.sh
-
       - name: Run platform tests
         working-directory: ${{ github.workspace }}/test/platform/riot
         run: ./runAll.sh
+
+      - name: Build examples
+        working-directory: ${{ github.workspace }}/examples/riot
+        run: ./buildAll.sh

examples/riot/README.md

@@ -35,62 +35,20 @@ First you need to create the `tap` interfaces so that the `sender` and `receiver
 sudo $RIOTBASE/dist/tools/tapsetup/tapsetup
 ```
 
-#### Get IPv6 address of receiver
+#### Start the Sender
 
-Enter the directory of the `sender` application:
-
-```shell
-cd coap_federated/sender
-```
-
-Get the IP address of the `receiver` by specifying the `PORT=tap1` and `ONLY_PRINT_IP=1` environment variables:
-
-*If the program returns more than one IP-Address then select the one that starts with `fe80`*.
-
-```shell
-make ONLY_PRINT_IP=1 BOARD=native PORT=tap1 all term
-```
-
-The resulting program will print out the IPv6 address of `tap1` and terminate. 
-This address must be used when starting the sender below.
-
-
-#### Get IPv6 address of sender
-
-Enter the directory of the `receiver` application:
-
-```shell
-cd coap_federated/receiver
-```
-
-Get the IP address of the `sender` by specifying the `PORT=tap0` and `ONLY_PRINT_IP=1` environment variables:
-
-*If the program returns more than one IP-Address then select the one that starts with `fe80`*.
-
-```shell
-make ONLY_PRINT_IP=1 BOARD=native PORT=tap0 all term
-```
-
-The resulting program will print out the IPv6 address of `tap0` and terminate. 
-This address must be used when starting the receiver below.
-
-#### Start the applications
-
-##### Sender
-Start the sender with `PORT=tap0`, make sure to replace `REMOTE_ADDRESS` with 
-the address of `tap1` that you found above.  
+Start the sender with `PORT=tap0`:
 
 ```shell
 cd sender
-make REMOTE_ADDRESS=fe80::8cc3:33ff:febb:1b3 BOARD=native PORT=tap0 all term
+make BOARD=native PORT=tap0 all term
 ```
 
-##### Receiver
+#### Start the Receiver
 
-Start the receiver with `PORT=tap1`, make sure to replace `REMOTE_ADDRESS` with 
-the address of `tap0` that you found above.  
+Start the receiver with `PORT=tap1`:
 
 ```shell
 cd receiver
-make REMOTE_ADDRESS=fe80::44e5:1bff:fee4:dac8 BOARD=native PORT=tap1 all term
+make BOARD=native PORT=tap1 all term
 ```

examples/riot/coap_federated/build.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
-REMOTE_ADDRESS=fe80::8cc3:33ff:febb:1b3 make all -C ./sender
-REMOTE_ADDRESS=fe80::44e5:1bff:fee4:dac8 make all -C ./receiver
+make all -C ./sender
+make all -C ./receiver

examples/riot/coap_federated/receiver/Makefile

@@ -29,17 +29,11 @@ CFLAGS += -DCONFIG_GCOAP_NO_RETRANS_BACKOFF=1
 CFLAGS += -DCONFIG_COAP_ACK_TIMEOUT_MS=400
 CFLAGS += -DCONFIG_COAP_MAX_RETRANSMIT=4
 
-# Check if ONLY_PRINT_IP is defined
-# If ONLY_PRINT_IP is defined the REMOTE_ADDRESS is not needed
-ifdef ONLY_PRINT_IP
-  # ONLY_PRINT_IP is defined => Set CFLAGS for it
-  CFLAGS += -DONLY_PRINT_IP=$(ONLY_PRINT_IP)
-else ifdef REMOTE_ADDRESS
-  # REMOTE_ADDRESS is defined => Set CFLAGS for it
-  CFLAGS += -DREMOTE_ADDRESS=\"$(REMOTE_ADDRESS)\"
-else
-  # Neither is defined
-  $(error Either define REMOTE_ADDRESS or set ONLY_PRINT_IP=1 to print the IP-Address of this device.)
-endif
+# Local IPv6 address
+CFLAGS += -DCONFIG_GNRC_IPV6_STATIC_LLADDR='"fe80::cafe:cafe:cafe:2"'
+CFLAGS += -DCONFIG_GNRC_IPV6_STATIC_LLADDR_IS_FIXED=1
+
+# Remote Ipv6 address
+CFLAGS += -DREMOTE_IP_ADDRESS='"fe80::cafe:cafe:cafe:1"'
 
 include $(CURDIR)/../../../../make/riot/riot.mk

examples/riot/coap_federated/receiver/main.c

@@ -1,10 +1,6 @@
 #include "reactor-uc/platform/riot/coap_udp_ip_channel.h"
 #include "reactor-uc/reactor-uc.h"
 
-#ifndef REMOTE_ADDRESS
-#define REMOTE_ADDRESS "fe80::44e5:1bff:fee4:dac8"
-#endif
-
 #define REMOTE_PROTOCOL_FAMILY AF_INET6
 
 typedef struct {
@@ -53,8 +49,8 @@ LF_REACTOR_CTOR_SIGNATURE_WITH_PARAMETERS(Receiver, InputExternalCtorArgs *in_ex
   LF_PORT_REGISTER_EFFECT(self->in, self->r, 1);
 }
 
-LF_DEFINE_FEDERATED_INPUT_CONNECTION_STRUCT(Receiver, in, msg_t, 5);
-LF_DEFINE_FEDERATED_INPUT_CONNECTION_CTOR(Receiver, in, msg_t, 5, MSEC(100), false);
+LF_DEFINE_FEDERATED_INPUT_CONNECTION_STRUCT(Receiver, in, lf_msg_t, 5);
+LF_DEFINE_FEDERATED_INPUT_CONNECTION_CTOR(Receiver, in, lf_msg_t, 5, MSEC(100), false);
 
 typedef struct {
   FederatedConnectionBundle super;
@@ -65,7 +61,7 @@ typedef struct {
 
 LF_FEDERATED_CONNECTION_BUNDLE_CTOR_SIGNATURE(Receiver, Sender) {
   LF_FEDERATED_CONNECTION_BUNDLE_CTOR_PREAMBLE();
-  CoapUdpIpChannel_ctor(&self->channel, REMOTE_ADDRESS, REMOTE_PROTOCOL_FAMILY);
+  CoapUdpIpChannel_ctor(&self->channel, REMOTE_IP_ADDRESS, REMOTE_PROTOCOL_FAMILY);
   LF_FEDERATED_CONNECTION_BUNDLE_CALL_CTOR();
   LF_INITIALIZE_FEDERATED_INPUT_CONNECTION(Receiver, in, deserialize_msg_t);
 }
@@ -89,30 +85,7 @@ LF_REACTOR_CTOR_SIGNATURE(MainRecv) {
 
 LF_ENTRY_POINT_FEDERATED(MainRecv, SEC(1), true, true, 1, false)
 
-void print_ip_addresses(void) {
-  gnrc_netif_t *netif = gnrc_netif_iter(NULL);
-  char addr_str[IPV6_ADDR_MAX_STR_LEN];
-
-  while (netif) {
-    size_t max_addr_count = 4;
-    ipv6_addr_t addrs[max_addr_count];
-    gnrc_netif_ipv6_addrs_get(netif, addrs, max_addr_count * sizeof(ipv6_addr_t));
-
-    for (size_t i = 0; i < 2; i++) {
-      if (ipv6_addr_to_str(addr_str, &addrs[i], sizeof(addr_str))) {
-        LF_INFO(NET, "IPv6 address: %s", addr_str);
-      }
-    }
-
-    netif = gnrc_netif_iter(netif);
-  }
-}
-
 int main() {
-#ifdef ONLY_PRINT_IP
-  print_ip_addresses();
-#else
   lf_start();
-#endif
   return 0;
 }

examples/riot/coap_federated/sender/Makefile

@@ -29,17 +29,11 @@ CFLAGS += -DCONFIG_GCOAP_NO_RETRANS_BACKOFF=1
 CFLAGS += -DCONFIG_COAP_ACK_TIMEOUT_MS=400
 CFLAGS += -DCONFIG_COAP_MAX_RETRANSMIT=4
 
-# Check if ONLY_PRINT_IP is defined
-# If ONLY_PRINT_IP is defined the REMOTE_ADDRESS is not needed
-ifdef ONLY_PRINT_IP
-  # ONLY_PRINT_IP is defined => Set CFLAGS for it
-  CFLAGS += -DONLY_PRINT_IP=$(ONLY_PRINT_IP)
-else ifdef REMOTE_ADDRESS
-  # REMOTE_ADDRESS is defined => Set CFLAGS for it
-  CFLAGS += -DREMOTE_ADDRESS=\"$(REMOTE_ADDRESS)\"
-else
-  # Neither is defined
-  $(error Either define REMOTE_ADDRESS or set ONLY_PRINT_IP=1 to print the IP-Address of this device)
-endif
+# Local IPv6 address
+CFLAGS += -DCONFIG_GNRC_IPV6_STATIC_LLADDR='"fe80::cafe:cafe:cafe:1"'
+CFLAGS += -DCONFIG_GNRC_IPV6_STATIC_LLADDR_IS_FIXED=1
+
+# Remote Ipv6 address
+CFLAGS += -DREMOTE_IP_ADDRESS='"fe80::cafe:cafe:cafe:2"'
 
 include $(CURDIR)/../../../../make/riot/riot.mk

examples/riot/coap_federated/sender/main.c

@@ -1,10 +1,6 @@
 #include "reactor-uc/reactor-uc.h"
 #include "reactor-uc/platform/riot/coap_udp_ip_channel.h"
 
-#ifndef REMOTE_ADDRESS
-#define REMOTE_ADDRESS "fe80::8cc3:33ff:febb:1b3"
-#endif
-
 #define REMOTE_PROTOCOL_FAMILY AF_INET6
 
 typedef struct {
@@ -60,8 +56,8 @@ LF_REACTOR_CTOR_SIGNATURE_WITH_PARAMETERS(Sender, OutputExternalCtorArgs *out_ex
   LF_PORT_REGISTER_SOURCE(self->out, self->r, 1);
 }
 
-LF_DEFINE_FEDERATED_OUTPUT_CONNECTION_STRUCT(Sender, out, msg_t)
-LF_DEFINE_FEDERATED_OUTPUT_CONNECTION_CTOR(Sender, out, msg_t)
+LF_DEFINE_FEDERATED_OUTPUT_CONNECTION_STRUCT(Sender, out, lf_msg_t)
+LF_DEFINE_FEDERATED_OUTPUT_CONNECTION_CTOR(Sender, out, lf_msg_t)
 
 typedef struct {
   FederatedConnectionBundle super;
@@ -72,7 +68,7 @@ typedef struct {
 
 LF_FEDERATED_CONNECTION_BUNDLE_CTOR_SIGNATURE(Sender, Receiver) {
   LF_FEDERATED_CONNECTION_BUNDLE_CTOR_PREAMBLE();
-  CoapUdpIpChannel_ctor(&self->channel, REMOTE_ADDRESS, REMOTE_PROTOCOL_FAMILY);
+  CoapUdpIpChannel_ctor(&self->channel, REMOTE_IP_ADDRESS, REMOTE_PROTOCOL_FAMILY);
   LF_FEDERATED_CONNECTION_BUNDLE_CALL_CTOR();
   LF_INITIALIZE_FEDERATED_OUTPUT_CONNECTION(Sender, out, serialize_msg_t);
 }
@@ -99,30 +95,7 @@ LF_REACTOR_CTOR_SIGNATURE(MainSender) {
 
 LF_ENTRY_POINT_FEDERATED(MainSender, SEC(1), true, false, 1, true)
 
-void print_ip_addresses(void) {
-  gnrc_netif_t *netif = gnrc_netif_iter(NULL);
-  char addr_str[IPV6_ADDR_MAX_STR_LEN];
-
-  while (netif) {
-    size_t max_addr_count = 4;
-    ipv6_addr_t addrs[max_addr_count];
-    gnrc_netif_ipv6_addrs_get(netif, addrs, max_addr_count * sizeof(ipv6_addr_t));
-
-    for (size_t i = 0; i < 2; i++) {
-      if (ipv6_addr_to_str(addr_str, &addrs[i], sizeof(addr_str))) {
-        LF_INFO(NET, "IPv6 address: %s", addr_str);
-      }
-    }
-
-    netif = gnrc_netif_iter(netif);
-  }
-}
-
 int main() {
-#ifdef ONLY_PRINT_IP
-  print_ip_addresses();
-#else
   lf_start();
-#endif
   return 0;
 }

examples/riot/coap_federated_lf/src/CoapFederatedLF.lf

@@ -1,41 +1,41 @@
 target uC {
-    platform: RIOT,
-    timeout: 1sec
-  }
-  
-  reactor Src(id: int = 0) {
-    output out: int
-    reaction(startup) -> out{=
-      printf("Hello from Src!\n");
-      lf_set(out, self->id);
-    =}
-  }
-  
-  reactor Dst {
-    input in: int
-    state check: bool = false
-    reaction(startup) {=
-      printf("Hello from Dst!\n");
-    =}
-    reaction(in) {=
-      printf("Received %d from Src\n", in->value);
-      validate(in->value == 42);
-      self->check = true;
-      env->request_shutdown(env);
-    =}
-  
-    reaction(shutdown) {=
-      validate(self->check);
-    =}
-  }
-  
-  federated reactor {
-    @interface_coap(name="if1", address="fe80::44e5:1bff:fee4:dac8")
-    r1 = new Src(id=42)
+  platform: RIOT,
+  timeout: 1sec
+}
 
-    @interface_coap(name="if1", address="fe80::8cc3:33ff:febb:1b3")
-    r2 = new Dst()
+reactor Src(id: int = 0) {
+  output out: int
+  reaction(startup) -> out{=
+    printf("Hello from Src!\n");
+    lf_set(out, self->id);
+  =}
+}
 
-    @link(left="if1", right="if1")
-    r1.out -> r2.in 
-  }
+reactor Dst {
+  input in: int
+  state check: bool = false
+  reaction(startup) {=
+    printf("Hello from Dst!\n");
+  =}
+  reaction(in) {=
+    printf("Received %d from Src\n", in->value);
+    validate(in->value == 42);
+    self->check = true;
+    env->request_shutdown(env);
+  =}
+
+  reaction(shutdown) {=
+    validate(self->check);
+  =}
+}
+
+federated reactor {
+  @interface_coap(name="if1", address="fe80::44e5:1bff:fee4:dac8")
+  r1 = new Src(id=42)
+
+  @interface_coap(name="if1", address="fe80::8cc3:33ff:febb:1b3")
+  r2 = new Dst()
+
+  @link(left="if1", right="if1")
+  r1.out -> r2.in 
+}