mercurial/testing/__init__.py
author Manuel Jacob <me@manueljacob.de>
Mon, 05 Aug 2024 20:47:17 +0200
branchstable
changeset 51672 99632adff795
parent 49672 8e0d823ef182
permissions -rw-r--r--
py3: fix type of some elements of __all__ lists
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46984
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     1
import os
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     2
import time
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     3
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     4
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     5
# work around check-code complains
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     6
#
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     7
# This is a simple log level module doing simple test related work, we can't
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     8
# import more things, and we do not need it.
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
     9
environ = getattr(os, 'environ')
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    10
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    11
49672
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    12
def wait_on_cfg(ui, cfg, timeout=10):
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    13
    """synchronize on the `cfg` config path
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    14
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    15
    Use this to synchronize commands during race tests.
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    16
    """
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    17
    full_config = b'sync.' + cfg
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    18
    wait_config = full_config + b'-timeout'
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    19
    sync_path = ui.config(b'devel', full_config)
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    20
    if sync_path is not None:
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    21
        timeout = ui.config(b'devel', wait_config)
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    22
        ready_path = sync_path + b'.waiting'
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    23
        write_file(ready_path)
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    24
        wait_file(sync_path, timeout=timeout)
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    25
8e0d823ef182 testing: introduce util function to synchronize concurrent commands on files
Raphaël Gomès <rgomes@octobus.net>
parents: 48966
diff changeset
    26
46984
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    27
def _timeout_factor():
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    28
    """return the current modification to timeout"""
47498
2dac94edd98d testing: fix _timeout_factor
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46985
diff changeset
    29
    default = int(environ.get('HGTEST_TIMEOUT_DEFAULT', 360))
46984
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    30
    current = int(environ.get('HGTEST_TIMEOUT', default))
47498
2dac94edd98d testing: fix _timeout_factor
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46985
diff changeset
    31
    if current == 0:
2dac94edd98d testing: fix _timeout_factor
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46985
diff changeset
    32
        return 1
46984
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    33
    return current / float(default)
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    34
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    35
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    36
def wait_file(path, timeout=10):
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    37
    timeout *= _timeout_factor()
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    38
    start = time.time()
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    39
    while not os.path.exists(path):
47657
1bad89a67745 testing: do not stop waiting if timeout is 0 (issue6541)
Cédric Krier <ced@b2ck.com>
parents: 47498
diff changeset
    40
        if timeout and time.time() - start > timeout:
46984
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    41
            raise RuntimeError(b"timed out waiting for file: %s" % path)
99c629101b73 testing: add a utility function to wait for file create
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 39788
diff changeset
    42
        time.sleep(0.01)
46985
52cee44aa1a0 testing: add a `write_file` function
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46984
diff changeset
    43
52cee44aa1a0 testing: add a `write_file` function
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46984
diff changeset
    44
52cee44aa1a0 testing: add a `write_file` function
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46984
diff changeset
    45
def write_file(path, content=b''):
47799
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    46
    if content:
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    47
        write_path = b'%s.tmp' % path
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    48
    else:
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    49
        write_path = path
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    50
    with open(write_path, 'wb') as f:
46985
52cee44aa1a0 testing: add a `write_file` function
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 46984
diff changeset
    51
        f.write(content)
47799
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    52
    if path != write_path:
5ad37164a8fe testing: make sure write_file is "atomic"
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 47657
diff changeset
    53
        os.rename(write_path, path)