Include information about changes in documentation

Describe Roda app that is used for testing.
Describe new feature for handling certificate file path
This commit is contained in:
Maciej Szlosarczyk 2019-07-12 16:07:30 +03:00
parent 55d1942898
commit d447c7c6c4
No known key found for this signature in database
GPG key ID: 41D62D42D3B0D765
4 changed files with 26 additions and 8 deletions

View file

@ -11,7 +11,7 @@ install:
- "/bin/bash -l -c \"cd apps/epp_proxy/priv/test_backend_app && bundle install\""
script:
- "/bin/bash -l -c \"cd apps/epp_proxy/priv/test_backend_app && bundle exec rackup -D\""
- "/bin/bash -l -c \"cd apps/epp_proxy/priv/test_backend_app && bundle exec rackup --pid pidfile -D\""
- "rebar3 as test compile"
- "DEBUG=1 rebar3 ct --sys_config config/test.config --readable=false --cover --verbose=true"
- "rebar3 cover --verbose"

View file

@ -82,10 +82,10 @@ of Erlang property list.
| `epp_session_url` | `https://example.com/epp/session` | EppSessionRoot | HTTP address of the session endpoints including schema and port.
| `epp_command_url` | `https://example.com/epp/command` | EppCommandRoot | HTTP address of the command endpoints including schema and port.
| `epp_error_url` | `https://example.com/epp/error` | EppErrorRoot | HTTP address of the error endpoints including schema and port.
| `cacertfile_path` | `/opt/ca/ca.crt.pem` | SSLCACertificateFile | Where is the client root CA located.
| `certfile_path` | `/opt/ca/server.crt.pem` | SSLCertificateFile | Where is the server certificate located.
| `keyfile_path` | `/opt/ca/server.key.pem` | SSLCertificateKeyFile | Where is the server key located.
| `crlfile_path` | `/opt/ca/crl.pem` | SSLCARevocationFile | Where is the CRL file located.
| `cacertfile_path` | `/opt/ca/ca.crt.pem` | SSLCACertificateFile | Where is the client root CA located. Can be inside apps/epp_proxy/priv or absolute path.
| `certfile_path` | `/opt/ca/server.crt.pem` | SSLCertificateFile | Where is the server certificate located. Can be inside apps/epp_proxy/priv or absolute path.
| `keyfile_path` | `/opt/ca/server.key.pem` | SSLCertificateKeyFile | Where is the server key located. Can be inside apps/epp_proxy/priv or absolute path.
| `crlfile_path` | `/opt/ca/crl.pem` | SSLCARevocationFile | Where is the CRL file located. Can be inside apps/epp_proxy/priv or absolute path.
Migrating from mod_epp
@ -100,6 +100,24 @@ Checklist of steps to perform if you want to migrate from mod_epp, but still use
5. If you do not feel comfortable using Erlang configuration file, you can use command line arguments and flags in format of `/epp_proxy/rel/bin/epp_proxy -epp_proxy tls_port 444`, where `-epp_proxy` is name of application,
followed by configuration parameter name and value.
Testing
----
The application comes with test suite written with common_test. For integration
tests, there is a small Roda application located in apps/epp_proxy/priv/test_backend_app.
It has been written with Ruby 2.6.3
You need to start it before running the test suite. To start it as a deamon,
from the root folder of the project, execute:
```bash
$ /bin/bash -l -c "cd apps/epp_proxy/priv/test_backend_app && bundle install"
$ /bin/bash -l -c "cd apps/epp_proxy/priv/test_backend_app && bundle exec rackup --pid pidfile -D"
```
After you finish testing, you can stop the process by reading the stored pid:
$ kill `cat apps/epp_proxy/priv/test_backend_app/pidfile`
TODO
----

View file

@ -2,7 +2,7 @@
require "rack/unreloader"
Unreloader = Rack::Unreloader.new() { BackendServer }
Unreloader.require("backend_server.rb") { "BackendServer" }
Unreloader = Rack::Unreloader.new() { EppServer }
Unreloader.require("epp_server.rb") { "EppServer" }
run(Unreloader)

View file

@ -1,6 +1,6 @@
require 'roda'
class BackendServer < Roda
class EppServer < Roda
plugin :render
route do |r|