Fix windows integration tests. #498

tomprince · 2021-07-19T05:11:37Z

Fixes #503.

Uses the correct paths for executables in the tahoe virtualenv
Uses stderr to capture eliot logs on windows (since we can't pass a pipe on FD 3)
Ensures we don't hang the integration tests if a service fails to start.
Uses psutil to suspend tahoe, since SIGSTOP doesn't exist on windows
Don't block the reactor when sleeping in integration tests
Ensure that log output from services is unbuffered on windows.
Ensure that the folder state database is closed before trying to remove a folder in the integration tests.

This might also address #484.

…d functions. `eliot.log_call` uses introspection to find the argument names of a call. However: - it doesn't look through wrappers - on python 2, we can't access the wrapped generator function of a `inline_callbacks` decorated function. This introduces a wrapper around both `log_call_deferred` and `inline_callbacks` that gives `log_call_deferred` access to the original function for introspection. It also extends `log_call_deferred` to be able to log arguments, similiar to `eliot.log_call`

If a service fails before we think it has started, we would hang forever waiting for the process to start. Instead, report an error to the caller.

On windows, SIGSTOP doesn't exist, but psutil implements a way of suspending a process.

Windows uses `/scripts` instead of `/bin` for executables in a virtualenv. Expose an object representing the tahoe virtualenv that knows the correct paths.

Windows doesn't support passing file descriptors to child process, beyond stdin/stdout/stderr. Therefore, we use stderr to capture eliot logs there, making sure that other output is ignored.

codecov · 2021-07-19T17:16:43Z

Codecov Report

Merging #498 (e3973ff) into main (c352b97) will decrease coverage by 0.02%.
The diff coverage is 96.77%.

@@            Coverage Diff             @@
##             main     #498      +/-   ##
==========================================
- Coverage   92.02%   92.00%   -0.03%     
==========================================
  Files          35       35              
  Lines        3072     3100      +28     
  Branches      361      369       +8     
==========================================
+ Hits         2827     2852      +25     
- Misses        170      173       +3     
  Partials       75       75

Flag	Coverage Δ
integration	`72.61% <51.61%> (+0.02%)`	⬆️
unit-test	`88.74% <83.87%> (-0.03%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/magic_folder/util/eliotutil.py	`90.34% <96.77%> (+1.15%)`	⬆️
src/magic_folder/util/file.py	`86.11% <0.00%> (-5.56%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c352b97...e3973ff. Read the comment docs.

exarkun

Thanks. Some simple comments inline. Please address and then merge.

exarkun · 2021-07-26T13:35:47Z

src/magic_folder/util/eliotutil.py

 """
 Like ``eliot.log_call`` but for functions which return ``Deferred``.
 """
+
+ if include_args:
+ if include_args is True:


I guess this less than wonderful bool/list signature is copied from Eliot so it makes sense to keep it instead of doing something less confusing...

Not exactly; eliot treats None as include everything, instead of True.

integration/conftest.py

exarkun · 2021-07-26T13:38:13Z

integration/conftest.py

@@ -155,12 +163,12 @@ def tahoe_venv(request, reactor):

 venv_dir = parser.get("testenv:{}".format(tahoe_env), 'envdir')

- return Path(venv_dir)
+ return VirtualEnv(Path(venv_dir))


exarkun · 2021-07-26T13:41:18Z

integration/util.py

+ # If we've accessed the folder state database from the integration
+ # tests, make sure that the connection has been closed before we
+ # try to remove the database. This is necessary on windows,
+ # otherwise the state database can't be removed.


It seems like this might suggest that we actually shouldn't even keep a long-lived connection to the database? Perhaps there are other factors to balance this consideration against ... but "connecting" to a SQLite3 database is not a particularly expensive operations and simplifying resource management by cutting down on the number of long-lived resources to manage might be worth it.

I don't think it makes sense for each test that access a folder state database to reach into MagicFolderConfig.database and close it (I suspect that attribute should actually be private).

It isn't so much that we want to keep long-lived connections open, but that there isn't a good API for closing them. Part of the issue is we keep a cache of MagicFolderConfig obejcts on GlobalConfigDatabase (to ensure that we only have a single connection to each state database, and that we have access to it to close it), and there is not an API for removing an object from that cache. (See f4bbe95 for details.) I'm open to other suggestions on how to handle the interactions here.

exarkun · 2021-07-26T13:42:53Z

integration/util.py

+ Since FD 3 is suppposed to only have eliot-logs, log them as malformed.
+ """
+ with self._action.context():
+ Message.log(message_type=u"malformed-eliot-log", data=data)


Can we also make this into a test-failing event so that if/when such things arise in the future we can catch them quickly? Or is there so much garbage on FD 3 that it's not even worth trying to make it clean?

It is not straight-forward to do this for a couple of reasons:

the service is not scoped to a single test

I don't think raising an exception here would cause the test to fail, as it will be swallowed by the reactor.

I filed #510 to address this. As it stands, I don't think we should ever hit this, as FD 3 is explicitly for eliot log messages.

integration/util.py

tomprince added 7 commits July 6, 2021 11:58

Ensure that log output of services in integeration tests is unbuffered.

a8d0837

Report an error when an service fails in integrations tests.

006aeab

If a service fails before we think it has started, we would hang forever waiting for the process to start. Instead, report an error to the caller.

Use psutil to suspend tahoe process in integration tests.

07899a8

On windows, SIGSTOP doesn't exist, but psutil implements a way of suspending a process.

Use correct paths for virtualenv executables on windows.

7f9356b

Windows uses `/scripts` instead of `/bin` for executables in a virtualenv. Expose an object representing the tahoe virtualenv that knows the correct paths.

Use stderr on windows to capture eliot logs in integration tests.

72a06c5

Windows doesn't support passing file descriptors to child process, beyond stdin/stdout/stderr. Therefore, we use stderr to capture eliot logs there, making sure that other output is ignored.

Let windows integrations tests to cause workflow failures.

a0ce9bb

tomprince added 2 commits July 20, 2021 12:38

Don't block the reactor while sleeping in integration tests.

d2fadf2

Ensure that the folder state database is closed in the integration test.

f0a193f

tomprince marked this pull request as ready for review July 20, 2021 20:56

tomprince added the needs-review label Jul 20, 2021

exarkun approved these changes Jul 26, 2021

View reviewed changes

exarkun removed the needs-review label Jul 26, 2021

tomprince mentioned this pull request Jul 26, 2021

Fail integration tests if we receive extraneous output on FD 3. #510

Open

Stop using Deferred.called in _MagicTextProtocol.

e3973ff

tomprince merged commit 3222d83 into tahoe-lafs:main Jul 28, 2021

tomprince deleted the fix-windows-integration-tests branch July 28, 2021 00:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix windows integration tests. #498

Fix windows integration tests. #498

tomprince commented Jul 19, 2021 •

edited

Loading

codecov bot commented Jul 19, 2021 •

edited

Loading

exarkun left a comment

exarkun Jul 26, 2021

tomprince Jul 27, 2021

exarkun Jul 26, 2021

exarkun Jul 26, 2021

tomprince Jul 26, 2021

exarkun Jul 26, 2021

tomprince Jul 26, 2021 •

edited

Loading

Fix windows integration tests. #498

Fix windows integration tests. #498

Conversation

tomprince commented Jul 19, 2021 • edited Loading

codecov bot commented Jul 19, 2021 • edited Loading

Codecov Report

exarkun left a comment

Choose a reason for hiding this comment

exarkun Jul 26, 2021

Choose a reason for hiding this comment

tomprince Jul 27, 2021

Choose a reason for hiding this comment

exarkun Jul 26, 2021

Choose a reason for hiding this comment

exarkun Jul 26, 2021

Choose a reason for hiding this comment

tomprince Jul 26, 2021

Choose a reason for hiding this comment

exarkun Jul 26, 2021

Choose a reason for hiding this comment

tomprince Jul 26, 2021 • edited Loading

Choose a reason for hiding this comment

tomprince commented Jul 19, 2021 •

edited

Loading

codecov bot commented Jul 19, 2021 •

edited

Loading

tomprince Jul 26, 2021 •

edited

Loading