Allow consumer to configure styx test api server ports. #187
Conversation
mikkokar
force-pushed
the
test-api-server-ports
branch
from
9537667
to
4a082bb
Compare
| private int proxyHttpsPort; | ||
|
|
||
| /** | ||
| * Specifies the HTTP port for proxy server. |
There was a problem hiding this comment.
These methods should have javadoc comments explain that the endpoints will be assigned random free ports if not set explicitly.
There was a problem hiding this comment.
Side note: Speaking of documentation, we do not have actual documentation for using the test-api yet, but we have an issue #177 regarding this.
There was a problem hiding this comment.
Ok, I will fix the documentation.
There was a problem hiding this comment.
Setting it to zero will do it, but it's probably a more likely use case for someone to simply not call the method at all. I would phrase the comment like:
By default, Styx will automatically allocate a free port number. This happens when a port is not set a value on the builder, or it is set a value of 0 (zero).
| private int proxyHttpsPort; | ||
|
|
||
| /** | ||
| * Specifies the HTTP port for proxy server. |
There was a problem hiding this comment.
Setting it to zero will do it, but it's probably a more likely use case for someone to simply not call the method at all. I would phrase the comment like:
By default, Styx will automatically allocate a free port number. This happens when a port is not set a value on the builder, or it is set a value of 0 (zero).
Makes it possible for plugin tests to configure HTTP port numbers for the test server.