Skip to content

test(sdkharness): upload.stall runs through the CLI's CI request-timeout hook #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sophiecarreras wants to merge 1 commit into
base: master
Choose a base branch
from
Open

test(sdkharness): upload.stall runs through the CLI's CI request-timeout hook #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions .sdkharness/tests/resilience-upload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ class Cli:
bin/conformance/B2_Command_Line_Tool/files.upload reaches @simulator.
"""

def __init__(self, scratch: str) -> None:
def __init__(self, scratch: str, extra_env: Mapping[str, str] | None = None) -> None:
self.scratch = scratch
self.env = {k: v for k, v in os.environ.items() if not k.startswith('B2_')}
self.env.update(
Expand All @@ -200,6 +200,7 @@ def __init__(self, scratch: str) -> None:
B2_ACCOUNT_INFO=os.path.join(scratch, 'account-info'),
XDG_CONFIG_HOME=os.path.join(scratch, 'xdg'),
)
self.env.update(extra_env or {})
os.makedirs(self.env['XDG_CONFIG_HOME'])

def run(self, *args):
Expand Down Expand Up @@ -242,13 +243,13 @@ def json_of(text: str):
return json.loads(text[min(starts) :])


def setup():
def setup(extra_env: Mapping[str, str] | None = None):
"""An authorized CLI and a fresh bucket. There is no unreachable/unauthorized
amber: the runner supplies the server and the credential, so either failing
is a harness defect."""
scratch = tempfile.mkdtemp(prefix='sdkharness-res-cli.')
CLEANUP.append(scratch)
cli = Cli(scratch)
cli = Cli(scratch, extra_env)
cli.must('authenticate', 'account', 'authorize')
bucket = f'sdkharness-res-{uuid.uuid4().hex[:12]}'
cli.must('create bucket', 'bucket', 'create', bucket, 'allPrivate')
Expand Down Expand Up @@ -375,13 +376,17 @@ def run_retry() -> None:

def run_wire_fault() -> None:
kind = WIRE_SCENARIOS[SCENARIO]
if kind == 'stall':
raise Skip(
'no-client-option',
'the CLI exposes no supported per-request timeout shorter than the controlled stall',
)

cli, bucket = setup()
# STALL. The CLI has no timeout option, but b2/_internal/_cli/b2api.py shortens the
# b2sdk request timeouts (TIMEOUT_FOR_UPLOAD = 24 s, TRY_COUNT_DATA = 2) when `CI` is
# set and `GITHUB_REPOSITORY` ends with `/B2_Command_Line_Tool`: the setting the CLI's
# own CI uses. Only the stall scenario sets them, so the 60 s stall is abandoned after
# 24 s and the upload retries on a new upload URL. The CLI code is unchanged.
extra_env = (
{'CI': '1', 'GITHUB_REPOSITORY': 'Backblaze/B2_Command_Line_Tool'}
if kind == 'stall'
else None
)
cli, bucket = setup(extra_env)
payload = (b'sdkharness resilience wire fault ' * 64)[:1024]
arm()
uploaded_or_fail(put(cli, bucket, OBJECT_NAME, payload), payload)
Expand Down
1 change: 1 addition & 0 deletions changelog.d/+sdkharness-upload-stall-runnable.infrastructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The sdkharness `upload.stall` resilience check (`.sdkharness/tests/resilience-upload.py`) now runs instead of reporting `SKIP no-client-option`: it sets `CI` and `GITHUB_REPOSITORY` in the CLI's environment for that scenario only, which activates the short request timeouts the CLI already applies in its own CI (`b2/_internal/_cli/b2api.py`), so a 60 s stalled upload is abandoned and retried on a new upload URL.
Loading