Open mingan opened 6 years ago
Updated the test setup to get it running on Travis CI.
Sure, the basic idea is to move the most of the main
function to a separate function. main
now just gathers flags, sets up dependencies and calls this function. Tests do the same. Normal de-coupling from flags, global vars etc.
Each test spins up mock a set of SSH servers which only record command and provide them back for assertions, they don't do anything else. The server addresses are written into an SSH config file in a tmp directory alongside generated key and cert for the SSH servers, public and private key pair of the client.
Every test contains YAML string with the Supfile being tested. The test runs this Supfile from parsing YAML, to setting up App
and actually performing the commands. matcher_test.go
provides convenience functions for testing that commands were sent to the defined servers and can test individual exports or commands. It's based on comparing the requests sent to the servers as strings, nothing more.
The tests cover basic things like missing networks, commands, targets etc., simple command, sequence of commands, a target, --onlyHosts
, --exceptHosts
, hosts specified via inventory, default SUP_*
variables, setting global, network and command line variables as well as custom file name.
The code for the mock servers is horrible. I assume it can be improved but I just stitched it together from different examples and by trial and error.
I'm happy to answer any more questions.
This PR builds on top of https://github.com/pressly/sup/pull/134. It adds tests for sup commad as a sanity check of the existing functionality. In order to accomplish it I had to adjust the code in few places:
main
torunSupfile
so that it can be run from testsioutil.Discard
in testsSSHClient
got new fields so that I could remove the global variableinitAuthMethodOnce
preventing running the command multiple times (aka when running tests)The tests which need to spin up mock SSH servers, capture the requests and always respond with success. I barely understand this part and it's put together from different examples around the web.
I'm doing this as a preparation for tackling https://github.com/pressly/sup/issues/130.