Add missing documentation about tls testing #11440

mtomczykmobica · 2019-09-09T09:19:56Z

Description

In mbed-os/TESTS/netsocket/README.md we have example of setup test server only for unsecured sockets. This changes added manual how to setup test server for tls socket version.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ x ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@SeppoTakalo

Release Notes

0xc0170 · 2019-09-09T09:42:44Z

TESTS/netsocket/tls/cert.h

@@ -0,0 +1,31 @@
+#include "tls_tests.h"


add license header please

0xc0170 · 2019-09-10T07:49:27Z

@AnotherButler Please review

Edit document.

AnotherButler

Please address my comments.

AnotherButler · 2019-09-10T20:21:35Z

TESTS/netsocket/README.md

+1. Call `Socket::close(stack)`.
+1. Call `Socket::open(stack)`.
+1. Call `Socket::close(stack)`.
+1. Delete the socket.


Is there a difference between "Delete the socket" and "Destroy the socket"? We use "destroy" everywhere else.

I think both words are correct (means the same), but for consistency we can use "destroy" everywhere.

AnotherButler · 2019-09-10T20:21:52Z

TESTS/netsocket/README.md

+1. Call `TCPSocket::recv(<buffer>, 30);`.
+1. Repeat until `recv()` returns 0.
+1. Call `TCPSocket::close();`.
+1. Delete the socket.


Is there a difference between "Delete the socket" and "Destroy the socket"? We use "destroy" everywhere else.

I think both words are correct (means the same), but for consistency we can use "destroy" everywhere.

AnotherButler · 2019-09-10T20:22:26Z

TESTS/netsocket/README.md


-Second recv() should return zero because endpoint closed the connection.
-close() should return `NSAPI_ERROR_OK'.
+The first `recv()` returns more that zero. Something between 10 and 30 bytes (datetime string).


What is this saying? That is returns more than 0? That it returns between 10 and 30? Both?

Changed this sequence to:
The first recv() returns datetime string length (It is between 10 and 30 bytes)

AnotherButler · 2019-09-10T20:23:03Z

TESTS/netsocket/README.md

 ### TLSSOCKET_SEND_REPEAT

-**Description:** Run SOCKET_SEND_REPEATÂ for TLSSOCKET by using port number 2009.
+**Description:** Run `SOCKET_SEND_REPEATÂ` for TLSSOCKET by using port number 2009.


It looks like there's some weird formatting going on. Do we know what this symbol should be, or should we delete it?

AnotherButler · 2019-09-10T20:23:11Z

TESTS/netsocket/README.md

 ### TLSSOCKET_SEND_TIMEOUT

-**Description:** Run SOCKET_SEND_TIMEOUTÂ for TLSSOCKET by using port number 2009.
+**Description:** Run `SOCKET_SEND_TIMEOUTÂ` for TLSSOCKET by using port number 2009.


It looks like there's some weird formatting going on. Do we know what this symbol should be, or should we delete it?

Sorry but i don't know that. I propose to leave your changes.

should be SOCKET_SEND_TIMEOUT, lets remove the last char

Yes, you're right. I've removed it.

AnotherButler · 2019-09-10T20:23:18Z

TESTS/netsocket/README.md

 ### TLSSOCKET_ECHOTEST

-**Description:** Run SOCKET_ECHOTESTÂ for TLSSOCKET by using port number 2007.
+**Description:** Run `SOCKET_ECHOTESTÂ` for TLSSOCKET by using port number 2007.


It looks like there's some weird formatting going on. Do we know what this symbol should be, or should we delete it?

AnotherButler · 2019-09-10T20:23:23Z

TESTS/netsocket/README.md

 ### TLSSOCKET_ECHOTEST_NONBLOCK

-**Description:** Run SOCKET_ECHOTEST_NONBLOCKÂ for TLSSOCKET by using port number 2007.
+**Description:** Run `SOCKET_ECHOTEST_NONBLOCKÂ` for TLSSOCKET by using port number 2007.


It looks like there's some weird formatting going on. Do we know what this symbol should be, or should we delete it?

Sorry but i don't know that. I propose to leave your changes.

Similar to above, the last char should be deleted

Yes, you're right. I've removed it.

AnotherButler · 2019-09-10T20:23:31Z

TESTS/netsocket/README.md

 **Description:**

-Run TCPSOCKET_RECV_TIMEOUTÂ for TLSSOCKET by using port number 2007.
+Run `TCPSOCKET_RECV_TIMEOUTÂ` for TLSSOCKET by using port number 2007.


It looks like there's some weird formatting going on. Do we know what this symbol should be, or should we delete it?

mtomczykmobica

All changes after review added.

SeppoTakalo · 2019-09-11T14:14:47Z

TESTS/netsocket/README.md

-`Socket::open()` should first return `NSAPI_ERROR_OK` and second call `NSAPI_ERROR_PARAMETER`.
-
-
+`Socket::open()` first returns `NSAPI_ERROR_OK` and then calls `NSAPI_ERROR_PARAMETER`.


This is now incorrect. Both NSAPI_ERROR_OK and NSAPI_ERROR_PARAMETER are return values that Socket::open() can return.

When Socket::open() is first called, it returns NSAPI_ERROR_OK, when Socket::open() is called second time, it returns NSAPI_ERROR_PARAMETER.

Fixed that by change to more detailed description:
first call (socket was not opened) returns NSAPI_ERROR_OK and nexts calls (socet was opened by previous call Socket::open()) return NSAPI_ERROR_PARAMETER.

SeppoTakalo · 2019-09-11T14:16:50Z

TESTS/netsocket/README.md

 **Description:**

-Call `Socket::open()` followed by `Socket::close()` and then again `Socket::open()`. Should allow you to reuse the same object.
+Call `Socket::open()` followed by `Socket::close()` and then again `Socket::open()`. This allows you to reuse the same object.


I think it should stay in the form Should allow as we are testing at it is allowed.

Stack SHOULD allow us to do it, but it may fail to do so.

We are not the ones who have enabled, therefore this allows is a bit incorrect statement.

Back to previous version.

0xc0170 · 2019-09-18T08:23:03Z

CI started

mbed-ci · 2019-09-18T09:19:14Z

Test run: SUCCESS

Summary: 4 of 4 test jobs passed
Build number : 1
Build artifacts

0xc0170 requested changes Sep 9, 2019

View reviewed changes

0xc0170 requested a review from AnotherButler September 9, 2019 09:45

Add missing documentation about tls testing

da8dbca

mtomczykmobica force-pushed the ONME-4239 branch from 32476ef to da8dbca Compare September 9, 2019 09:55

mtomczykmobica requested a review from 0xc0170 September 10, 2019 05:22

0xc0170 approved these changes Sep 10, 2019

View reviewed changes

0xc0170 added the needs: review label Sep 10, 2019

Edit README.md

4c3cca0

Edit document.

AnotherButler reviewed Sep 10, 2019

View reviewed changes

mtomczykmobica commented Sep 11, 2019

View reviewed changes

mtomczykmobica force-pushed the ONME-4239 branch from 69edacc to 9f6ee48 Compare September 11, 2019 07:34

mtomczykmobica requested a review from AnotherButler September 11, 2019 07:47

SeppoTakalo reviewed Sep 11, 2019

View reviewed changes

SeppoTakalo approved these changes Sep 11, 2019

View reviewed changes

AnotherButler approved these changes Sep 11, 2019

View reviewed changes

Add missing documentation about tls testing - review comments fixes

df8e3c8

mtomczykmobica force-pushed the ONME-4239 branch from 9f6ee48 to df8e3c8 Compare September 12, 2019 05:52

mtomczykmobica requested a review from 0xc0170 September 13, 2019 05:10

0xc0170 approved these changes Sep 17, 2019

View reviewed changes

0xc0170 added needs: CI release-version: 5.14.1 and removed needs: review labels Sep 17, 2019

0xc0170 added ready for merge and removed needs: CI labels Sep 18, 2019

0xc0170 merged commit 926ffb0 into ARMmbed:master Sep 18, 2019

0xc0170 removed the ready for merge label Sep 18, 2019

michalpasztamobica mentioned this pull request Sep 20, 2019

[netsocket][tests] missing documentation about tls testing. #9942

Closed

		`Socket::open()` should first return `NSAPI_ERROR_OK` and second call `NSAPI_ERROR_PARAMETER`.


		`Socket::open()` first returns `NSAPI_ERROR_OK` and then calls `NSAPI_ERROR_PARAMETER`.

Add missing documentation about tls testing #11440

Add missing documentation about tls testing #11440

Uh oh!

Conversation

mtomczykmobica commented Sep 9, 2019

Description

Pull request type

Reviewers

Release Notes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented Sep 10, 2019

Uh oh!

AnotherButler left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica Sep 11, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtomczykmobica Sep 12, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xc0170 commented Sep 18, 2019

Uh oh!

mbed-ci commented Sep 18, 2019

Uh oh!

Uh oh!

mtomczykmobica Sep 11, 2019 •

edited

Loading

mtomczykmobica Sep 11, 2019 •

edited

Loading

mtomczykmobica Sep 11, 2019 •

edited

Loading

mtomczykmobica Sep 11, 2019 •

edited

Loading

mtomczykmobica left a comment •

edited

Loading

mtomczykmobica Sep 12, 2019 •

edited

Loading