native: add option to turn RIOT into a Linux CLI tool #20656

benpicco · 2024-05-07T17:45:00Z

Contribution description

To better integrate RIOT into some automated tests, it can be useful to run commands in a one-shot fashion.
This allows to use RIOT shell commands like Linux applications and integrate them into other tooling so e.g. Linux servers that interact with RIOT can be tested using a fixed RIOT binary.

Testing procedure

First create a TAP bridge with an (optional) uplink:

sudo dist/tools/tapsetup/tapsetup -u enxf4a80d90ba50

We can ping a host from RIOT

bin/native/nanocoap_tool.elf tap0 ping riot-os.org
12 bytes from 2a01:4f9:1a:9508::1: icmp_seq=0 ttl=57 time=58.149 ms
12 bytes from 2a01:4f9:1a:9508::1: icmp_seq=1 ttl=57 time=58.647 ms
12 bytes from 2a01:4f9:1a:9508::1: icmp_seq=2 ttl=57 time=58.381 ms

--- riot-os.org PING statistics ---
3 packets transmitted, 3 packets received, 0% packet loss
round-trip min/avg/max = 58.149/58.392/58.647 ms

We can also access CoAP servers

bin/native/nanocoap_tool.elf tap0 ncget coap://coap.me/
/test
/validate
/hello
/blåbærsyltetøy
/sink
/separate
/large
/secret
/broken
/weird33
/weird44
/weird55
/weird333
/weird3333
/weird33333
/123412341234123412341234
/location-query
/create1
/large-update
/large-create
/query
/seg1
/path
/location1
/multi-format
/3
/4
/5

Issues/PRs references

riot-ci · 2024-05-07T21:58:42Z

Murdock results

❌ FAILED

c0fd8ed examples/nanocoap_tool: add RIOT as a CLI tool

Success	Failures	Total	Runtime
9568	0	10145	10m:56s

Artifacts

Teufelchen1 · 2024-05-08T09:16:35Z

Cool idea! How about making it behave like busybox? ./ncget == ./nanocoap_tool.elf ncget?

I dislike that there is a new example that does not really have value as it - add the very least add a README! I am also surprised it is nanocoap specific? While coap is a good example use case, the example itself is more "riot as cli tool" and should be presented as such.

benpicco · 2024-05-08T11:07:47Z

I agree that the example needs to be more fleshed out, this is a bit specific to the 'send arbitrary CoAP payloads as a RIOT node would' use case, but not sure what else I should include.

Teufelchen1 · 2024-06-17T07:54:38Z

Is this ready for a review @benpicco ?

benpicco · 2024-06-17T08:45:24Z

Sure!

Teufelchen1

Looks good overall. Only minor comments and nits.

examples/nanocoap_tool/Makefile

Teufelchen1 · 2024-07-17T09:31:36Z

examples/nanocoap_tool/Makefile

+USEMODULE += shell
+USEMODULE += shell_cmds_default
+
+# export the whole fs to RIOT


Why? Wouldn't be "./" be sufficient for an example?

Paths in RIOT are always absolute, we don't have the concept of a current directory.
So to access main.c in the directory of the example we'd have to write /main.c which does not match the host file system.

examples/nanocoap_tool/main.c

Teufelchen1 · 2024-07-17T09:35:48Z

examples/nanocoap_tool/main.c

+    }
+
+    /* wait some time for the network to be ready */
+    ztimer_sleep(ZTIMER_MSEC, 1000);


Teufelchen1 · 2024-07-17T09:40:09Z

sys/shell/cmds/nanocoap_vfs.c

@@ -169,19 +169,34 @@ static int _nanocoap_put_handler(int argc, char **argv)
    file = argv[1];
    url = argv[2];

+    /* append filename to remote dir */


Why? (I also find the difference between the comments wording "filename" & "remote dir" confusing, given that the variables are called "file" and "url", but that's very much nit picking.)

This was there before, so when you write

ncput /path/to/foo.txt coap://example.com/in/

it will actually make a PUT request to coap://example.com/in/foo.txt

Does changing it to 'remote URL' make it clearer?

Teufelchen1 · 2024-07-17T09:43:13Z

sys/shell/cmds/nanocoap_vfs.c

            puts("Constructed URI too long");
            return -ENOBUFS;
        }
        url = buffer;
    }

+    /* relative file path */
+    if (*file != '/') {


I think that would make it more clear that inspecting the first character only is deliberate. (Again, nit)

Suggested change

if (*file != '/') {

if (file[0] != '/') {

Ah, this if is also take if file == "-". I think that is okay and can be ignored?

This was added as a convenience. We already have CONFIG_NCGET_DEFAULT_DATA_DIR to store downloads from ncget when the destination is not specified - so you can do

ncget coap://example.com/files/data.txt

and it will end up in CONFIG_NCGET_DEFAULT_DATA_DIR.
This is just the reverse: It allows you do to

ncput foo.txt coap://example.com/in/

without typing out the whole path.

sys/shell/cmds/nanocoap_vfs.c

sys/shell/shell.c

miri64 · 2024-07-18T08:36:06Z

A README for the example would be nice. It took me a while to wrap my head around the concept.

benpicco · 2024-08-19T14:19:18Z

I added a readme and some wrapper scripts

benpicco requested a review from kaspar030 as a code owner May 7, 2024 17:45

benpicco changed the title ~~Native tool~~ native: allow to run RIOT shell commands like native Linux commands May 7, 2024

benpicco changed the title ~~native: allow to run RIOT shell commands like native Linux commands~~ native: add option to turn RIOT into a Linux CLI tool May 7, 2024

benpicco force-pushed the native_tool branch from 977971d to bbea0d9 Compare May 7, 2024 21:45

benpicco added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label May 7, 2024

benpicco force-pushed the native_tool branch from bbea0d9 to 7997add Compare May 15, 2024 12:48

benpicco requested review from leandrolanzieri, jia200x, MrKevinWeiss, miri64, aabadie, MichelRottleuthner, PeterKietzmann, gschorcht, bergzand and dylad as code owners May 15, 2024 12:48

github-actions bot added Platform: MSP Platform: This PR/issue effects MSP-based platforms Platform: ARM Platform: This PR/issue effects ARM-based platforms Area: network Area: Networking Area: doc Area: Documentation Area: tests Area: tests and testing framework labels May 15, 2024

github-actions bot added Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: CoAP Area: Constrained Application Protocol implementations Area: Kconfig Area: Kconfig integration labels May 15, 2024

benpicco force-pushed the native_tool branch from 7997add to 51a6a84 Compare May 15, 2024 12:49

Teufelchen1 requested changes Jul 17, 2024

View reviewed changes

github-actions bot added the Area: doc Area: Documentation label Aug 19, 2024

benpicco added 4 commits September 12, 2024 13:30

cpu/native: be less verbose on startup

a1ae466

cpu/native: allow to pass arguments to the application

dc5f7e7

sys/shell: ncput: allow relative paths for source file

8db5372

board/native: make mount point configurable

960e584

benpicco force-pushed the native_tool branch from 9894968 to 7701fc5 Compare September 12, 2024 11:31

sys/shell: make find_handler() public

5bc5bfa

benpicco force-pushed the native_tool branch from 7701fc5 to d3dbcbc Compare September 12, 2024 14:39

examples/nanocoap_tool: add RIOT as a CLI tool

c0fd8ed

benpicco force-pushed the native_tool branch from d3dbcbc to c0fd8ed Compare September 12, 2024 14:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

native: add option to turn RIOT into a Linux CLI tool #20656

native: add option to turn RIOT into a Linux CLI tool #20656

benpicco commented May 7, 2024 •

edited

Loading

riot-ci commented May 7, 2024 •

edited

Loading

Teufelchen1 commented May 8, 2024

benpicco commented May 8, 2024

Teufelchen1 commented Jun 17, 2024

benpicco commented Jun 17, 2024

Teufelchen1 left a comment

Teufelchen1 Jul 17, 2024

benpicco Jul 17, 2024

Teufelchen1 Jul 17, 2024

Teufelchen1 Jul 17, 2024

benpicco Jul 17, 2024 •

edited

Loading

Teufelchen1 Jul 17, 2024

Teufelchen1 Jul 17, 2024 •

edited

Loading

benpicco Jul 17, 2024

miri64 commented Jul 18, 2024

benpicco commented Aug 19, 2024

native: add option to turn RIOT into a Linux CLI tool #20656

Are you sure you want to change the base?

native: add option to turn RIOT into a Linux CLI tool #20656

Conversation

benpicco commented May 7, 2024 • edited Loading

Contribution description

Testing procedure

Issues/PRs references

riot-ci commented May 7, 2024 • edited Loading

Murdock results

Artifacts

Teufelchen1 commented May 8, 2024

benpicco commented May 8, 2024

Teufelchen1 commented Jun 17, 2024

benpicco commented Jun 17, 2024

Teufelchen1 left a comment

Choose a reason for hiding this comment

Teufelchen1 Jul 17, 2024

Choose a reason for hiding this comment

benpicco Jul 17, 2024

Choose a reason for hiding this comment

Teufelchen1 Jul 17, 2024

Choose a reason for hiding this comment

Teufelchen1 Jul 17, 2024

Choose a reason for hiding this comment

benpicco Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

Teufelchen1 Jul 17, 2024

Choose a reason for hiding this comment

Teufelchen1 Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

benpicco Jul 17, 2024

Choose a reason for hiding this comment

miri64 commented Jul 18, 2024

benpicco commented Aug 19, 2024

benpicco commented May 7, 2024 •

edited

Loading

riot-ci commented May 7, 2024 •

edited

Loading

benpicco Jul 17, 2024 •

edited

Loading

Teufelchen1 Jul 17, 2024 •

edited

Loading