test: Update --tmpdir doc string to say directory must not exist #29498

kevkevinpal · 2024-02-28T00:47:32Z

The error message given if passing an existing dir to --tmpdir is confusing so this makes it clear that the directory must not already exist

This change is motivated by this comment #29335 (comment)

The error message given if passing an existing dir to --tmpdir is confusing so this makes it clear that the directory must not already exist

DrahtBot · 2024-02-28T00:47:34Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type	Reviewers
ACK	maflcko, davidgumberg

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Empact · 2024-02-28T07:05:35Z

Might you be able to modify the message as well? It will be the most available info when people encounter it.

maflcko · 2024-02-28T08:42:23Z

lgtm ACK d4e36ae

kevkevinpal · 2024-03-12T23:10:15Z

Updated in be027e0 I added a line to enable logging and it now gives this error which it did not before because it would throw an error because logging was not enabled

New Error message

./test/functional/feature_bind_port_discover.py --tmpdir=./temp
2024-03-12T23:08:06.633000Z TestFramework (ERROR): Unexpected exception caught during testing
Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 130, in main
    self.setup()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 267, in setup
    os.makedirs(self.options.tmpdir, exist_ok=False)
  File "<frozen os>", line 225, in makedirs
FileExistsError: [Errno 17] File exists: '/Users/kevkevin/DEVDIR/bitcoin/temp'
Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/./test/functional/feature_bind_port_discover.py", line 78, in <module>
    BindPortDiscoverTest().main()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 154, in main
    exit_code = self.shutdown()
                ^^^^^^^^^^^^^^^
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 310, in shutdown
    self.network_thread.close()
    ^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'close'

Previous Error message

Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 130, in main
    self.setup()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 266, in setup
    os.makedirs(self.options.tmpdir, exist_ok=False)
  File "<frozen os>", line 225, in makedirs
FileExistsError: [Errno 17] File exists: '/Users/kevkevin/DEVDIR/bitcoin/temp'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 148, in main
    self.log.exception("Unexpected exception caught during testing")
    ^^^^^^^^
AttributeError: 'BindPortDiscoverTest' object has no attribute 'log'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/./test/functional/feature_bind_port_discover.py", line 78, in <module>
    BindPortDiscoverTest().main()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 154, in main
    exit_code = self.shutdown()
                ^^^^^^^^^^^^^^^
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 304, in shutdown
    if self.success == TestStatus.FAILED and self.options.pdbonfailure:
       ^^^^^^^^^^^^
AttributeError: 'BindPortDiscoverTest' object has no attribute 'success'

kevkevinpal · 2024-03-12T23:10:57Z

I may want to find a way to remove the logs after FileExistsError: [Errno 17] File exists: '/Users/kevkevin/DEVDIR/bitcoin/temp' to make this error more clear

kevkevinpal · 2024-03-12T23:14:45Z

force pushed once more eb28434

the error log now makes sense

./test/functional/feature_bind_port_discover.py --tmpdir=./temp
2024-03-12T23:12:18.583000Z TestFramework (ERROR): Unexpected exception caught during testing
Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 130, in main
    self.setup()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 267, in setup
    os.makedirs(self.options.tmpdir, exist_ok=False)
  File "<frozen os>", line 225, in makedirs
FileExistsError: [Errno 17] File exists: '/Users/kevkevin/DEVDIR/bitcoin/temp'
2024-03-12T23:12:18.584000Z TestFramework (INFO): Stopping nodes
2024-03-12T23:12:18.584000Z TestFramework (WARNING): Not cleaning up dir /Users/kevkevin/DEVDIR/bitcoin/temp
2024-03-12T23:12:18.584000Z TestFramework (ERROR): Test failed. Test logging available at /Users/kevkevin/DEVDIR/bitcoin/temp/test_framework.log
2024-03-12T23:12:18.584000Z TestFramework (ERROR):
2024-03-12T23:12:18.584000Z TestFramework (ERROR): Hint: Call /Users/kevkevin/DEVDIR/bitcoin/test/functional/combine_logs.py '/Users/kevkevin/DEVDIR/bitcoin/temp' to consolidate all logs
2024-03-12T23:12:18.584000Z TestFramework (ERROR):
2024-03-12T23:12:18.584000Z TestFramework (ERROR): If this failure happened unexpectedly or intermittently, please file a bug and provide a link or upload of the combined log.
2024-03-12T23:12:18.585000Z TestFramework (ERROR): https://github.com/bitcoin/bitcoin/issues
2024-03-12T23:12:18.585000Z TestFramework (ERROR):

kevkevinpal · 2024-03-13T01:50:01Z

new error log in c5eb468

let me know if you want to change the verbiage and if the dir exists we use the default location and then raise and exception

./test/functional/p2p_tx_privacy.py --tmpdir=./tmp
2024-03-13T01:48:26.199000Z TestFramework (ERROR): The tmpdir must not already exist ./tmp
2024-03-13T01:48:26.200000Z TestFramework (ERROR): Unexpected exception caught during testing
Traceback (most recent call last):
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 130, in main
    self.setup()
  File "/Users/kevkevin/DEVDIR/bitcoin/test/functional/test_framework/test_framework.py", line 268, in setup
    os.makedirs(self.options.tmpdir, exist_ok=False)
  File "<frozen os>", line 225, in makedirs
FileExistsError: [Errno 17] File exists: '/Users/kevkevin/DEVDIR/bitcoin/tmp'
2024-03-13T01:48:26.201000Z TestFramework (INFO): Stopping nodes
2024-03-13T01:48:26.201000Z TestFramework (WARNING): Not cleaning up dir /var/folders/9g/cvx014yx4dq5lwl_x5zvn_j80000gn/T/bitcoin_func_test_9s71cl9w
2024-03-13T01:48:26.201000Z TestFramework (ERROR): Test failed. Test logging available at /var/folders/9g/cvx014yx4dq5lwl_x5zvn_j80000gn/T/bitcoin_func_test_9s71cl9w/test_framework.log
2024-03-13T01:48:26.201000Z TestFramework (ERROR):
2024-03-13T01:48:26.201000Z TestFramework (ERROR): Hint: Call /Users/kevkevin/DEVDIR/bitcoin/test/functional/combine_logs.py '/var/folders/9g/cvx014yx4dq5lwl_x5zvn_j80000gn/T/bitcoin_func_test_9s71cl9w' to consolidate all logs
2024-03-13T01:48:26.201000Z TestFramework (ERROR):
2024-03-13T01:48:26.201000Z TestFramework (ERROR): If this failure happened unexpectedly or intermittently, please file a bug and provide a link or upload of the combined log.
2024-03-13T01:48:26.201000Z TestFramework (ERROR): https://github.com/bitcoin/bitcoin/issues
2024-03-13T01:48:26.202000Z TestFramework (ERROR):

maflcko · 2024-03-13T08:07:58Z

test/functional/test_framework/test_framework.py

+            except Exception:
+                self.options.tmpdir = tempfile.mkdtemp(prefix=TMPDIR_PREFIX)
+                self._start_logging()
+                self.log.error("The tmpdir must not already exist {}".format(tmpdirpath))


Not sure about using a different tempdir than the one the user asked for as fallback to start logging.

I don't think code needs to be written for users that fail to read the docs, and also fail to read the python stacktrace?

yup that makes sense and I agree reverting back to d4e36ae

maflcko · 2024-03-13T15:26:05Z

rfm?

davidgumberg · 2024-04-08T22:51:41Z

ACK d4e36ae

test: Update --tmpdir doc string to say directory must not exist

d4e36ae

The error message given if passing an existing dir to --tmpdir is confusing so this makes it clear that the directory must not already exist

DrahtBot added the Tests label Feb 28, 2024

kevkevinpal force-pushed the tmpDirDocString branch 2 times, most recently from d782db0 to 191b985 Compare March 13, 2024 01:46

DrahtBot added the CI failed label Mar 13, 2024

kevkevinpal force-pushed the tmpDirDocString branch 5 times, most recently from be027e0 to eb28434 Compare March 13, 2024 01:47

kevkevinpal force-pushed the tmpDirDocString branch 2 times, most recently from c5eb468 to 09067cc Compare March 13, 2024 02:42

maflcko reviewed Mar 13, 2024

View reviewed changes

DrahtBot removed the CI failed label Mar 13, 2024

kevkevinpal force-pushed the tmpDirDocString branch from 09067cc to d4e36ae Compare March 13, 2024 14:44

bitcoin deleted a comment from Ashflower13 Apr 9, 2024

maflcko assigned fanquake Apr 9, 2024

fanquake merged commit a160a6a into bitcoin:master Apr 9, 2024
19 checks passed

Pttn added a commit to RiecoinTeam/Riecoin that referenced this pull request Apr 13, 2024

Merge bitcoin#29498

8b19f5b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: Update --tmpdir doc string to say directory must not exist #29498

test: Update --tmpdir doc string to say directory must not exist #29498

kevkevinpal commented Feb 28, 2024

DrahtBot commented Feb 28, 2024 •

edited

Empact commented Feb 28, 2024

maflcko commented Feb 28, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 13, 2024

maflcko Mar 13, 2024

kevkevinpal Mar 13, 2024

maflcko commented Mar 13, 2024

davidgumberg commented Apr 8, 2024

test: Update --tmpdir doc string to say directory must not exist #29498

test: Update --tmpdir doc string to say directory must not exist #29498

Conversation

kevkevinpal commented Feb 28, 2024

DrahtBot commented Feb 28, 2024 • edited

Code Coverage

Reviews

Empact commented Feb 28, 2024

maflcko commented Feb 28, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 12, 2024

kevkevinpal commented Mar 13, 2024

maflcko Mar 13, 2024

Choose a reason for hiding this comment

kevkevinpal Mar 13, 2024

Choose a reason for hiding this comment

maflcko commented Mar 13, 2024

davidgumberg commented Apr 8, 2024

DrahtBot commented Feb 28, 2024 •

edited