pyca / pyca/pyopenssl

Misleading docstring in test_renegotiation

Open
#1,216 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
944
Forks
440
Avg merge
1d 6h
Merged PRs (30d)
6

Description

as its written in the following link:

https://github.com/pyca/pyopenssl/blob/2d94946a938878ea10da479b7ac83ab1c434df4d/tests/test_ssl.py#LL3401C9-L3401C51

that test should represent "full renegotiation cycle" but instead of that it ends up on calling openssl bindings (renegotiation and handshake), and sudennly tests ends - never finishing mentioned "full cycle of renegotiation"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open tests/test_ssl.py at the linked test_renegotiation location and read its docstring alongside the test body. Update the docstring to accurately describe what the test executes, then run test_renegotiation to confirm the documentation matches the test's behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.