Skip to content
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.

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

Fix tests on Windows, add Windows CI #1186

Merged
merged 2 commits into from
Feb 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ jobs:
- {VERSION: "3.11", TOXENV: "py311"}
- {VERSION: "pypy-3.7", TOXENV: "pypy3"}
- {VERSION: "pypy-3.8", TOXENV: "pypy3"}
- {VERSION: "3.11", TOXENV: "py311-useWheel", OS: "windows-2022" }
# -cryptographyMain
- {VERSION: "3.6", TOXENV: "py36-cryptographyMain", OS: "ubuntu-20.04"}
- {VERSION: "3.7", TOXENV: "py37-cryptographyMain"}
Expand Down Expand Up @@ -47,7 +48,7 @@ jobs:
- {VERSION: "3.9", TOXENV: "flake8"}
- {VERSION: "3.6", TOXENV: "py36-mypy", OS: "ubuntu-20.04"}
- {VERSION: "3.9", TOXENV: "docs"}
name: "${{ matrix.PYTHON.TOXENV }}"
name: "${{ matrix.PYTHON.TOXENV }}${{ matrix.PYTHON.OS && format(' on {0}', matrix.PYTHON.OS) || '' }}"
steps:
- uses: actions/checkout@v3
- name: Setup python
Expand Down
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
Installation script for the OpenSSL package.
"""

import codecs
import os
import re

Expand All @@ -21,10 +20,12 @@

def read_file(*parts):
"""
Build an absolute path from *parts* and and return the contents of the
Build an absolute path from *parts* and return the contents of the
resulting file. Assume UTF-8 encoding.
"""
with codecs.open(os.path.join(HERE, *parts), "rb", "ascii") as f:
with open(
os.path.join(HERE, *parts), "r", encoding="utf-8", newline=None
) as f:
return f.read()


Expand Down
6 changes: 3 additions & 3 deletions tests/test_crypto.py
Original file line number Diff line number Diff line change
Expand Up @@ -2524,7 +2524,7 @@ def check_recovery(
b"-passin",
b"pass:" + passwd,
*extra,
)
).replace(b"\r\n", b"\n")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_runopenssl is also used with binary output, so we can't replace this in there for all invocations.

assert recovered_key[-len(key) :] == key
if cert:
recovered_cert = _runopenssl(
Expand All @@ -2536,7 +2536,7 @@ def check_recovery(
b"pass:" + passwd,
b"-nokeys",
*extra,
)
).replace(b"\r\n", b"\n")
assert recovered_cert[-len(cert) :] == cert
if ca:
recovered_cert = _runopenssl(
Expand All @@ -2548,7 +2548,7 @@ def check_recovery(
b"pass:" + passwd,
b"-nokeys",
*extra,
)
).replace(b"\r\n", b"\n")
assert recovered_cert[-len(ca) :] == ca

def verify_pkcs12_container(self, p12):
Expand Down
67 changes: 39 additions & 28 deletions tests/test_ssl.py
Original file line number Diff line number Diff line change
Expand Up @@ -1140,23 +1140,30 @@ def _load_verify_directory_locations_capath(self, capath):

self._load_verify_locations_test(None, capath)

def test_load_verify_directory_bytes_capath(self, tmpfile):
@pytest.mark.parametrize(
"pathtype",
[
"ascii_path",
pytest.param(
"unicode_path",
marks=pytest.mark.skipif(
platform == "win32",
reason="Unicode paths not supported on Windows",
),
),
],
)
@pytest.mark.parametrize("argtype", ["bytes_arg", "unicode_arg"])
def test_load_verify_directory_capath(self, pathtype, argtype, tmpfile):
"""
`Context.load_verify_locations` accepts a directory name as a `bytes`
instance and uses the certificates within for verification purposes.
"""
self._load_verify_directory_locations_capath(
tmpfile + NON_ASCII.encode(getfilesystemencoding())
)

def test_load_verify_directory_unicode_capath(self, tmpfile):
"""
`Context.load_verify_locations` accepts a directory name as a `unicode`
instance and uses the certificates within for verification purposes.
"""
self._load_verify_directory_locations_capath(
tmpfile.decode(getfilesystemencoding()) + NON_ASCII
)
if pathtype == "unicode_path":
tmpfile += NON_ASCII.encode(getfilesystemencoding())
if argtype == "unicode_arg":
tmpfile = tmpfile.decode(getfilesystemencoding())
self._load_verify_directory_locations_capath(tmpfile)

def test_load_verify_locations_wrong_args(self):
"""
Expand Down Expand Up @@ -2838,23 +2845,24 @@ def test_wantWriteError(self):
"""
client_socket, server_socket = socket_pair()
# Fill up the client's send buffer so Connection won't be able to write
# anything. Only write a single byte at a time so we can be sure we
# anything. Start by sending larger chunks (Windows Socket I/O is slow)
# and continue by writing a single byte at a time so we can be sure we
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This brings this test down from 16s to <20ms on my machine.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Socket I/O performance joins VFS performance on my Windows is bad list 😄

# completely fill the buffer. Even though the socket API is allowed to
# signal a short write via its return value it seems this doesn't
# always happen on all platforms (FreeBSD and OS X particular) for the
# very last bit of available buffer space.
msg = b"x"
for i in range(1024 * 1024 * 64):
try:
client_socket.send(msg)
except error as e:
if e.errno == EWOULDBLOCK:
break
raise
else:
pytest.fail(
"Failed to fill socket buffer, cannot test BIO want write"
)
for msg in [b"x" * 65536, b"x"]:
for i in range(1024 * 1024 * 64):
try:
client_socket.send(msg)
except error as e:
if e.errno == EWOULDBLOCK:
break
raise # pragma: no cover
else: # pragma: no cover
pytest.fail(
"Failed to fill socket buffer, cannot test BIO want write"
)

ctx = Context(SSLv23_METHOD)
conn = Connection(ctx, client_socket)
Expand Down Expand Up @@ -3753,13 +3761,16 @@ def test_unexpected_EOF(self):
"""
If the connection is lost before an orderly SSL shutdown occurs,
`OpenSSL.SSL.SysCallError` is raised with a message of
"Unexpected EOF".
"Unexpected EOF" (or WSAECONNRESET on Windows).
"""
server_conn, client_conn = loopback()
client_conn.sock_shutdown(SHUT_RDWR)
with pytest.raises(SysCallError) as err:
server_conn.recv(1024)
assert err.value.args == (-1, "Unexpected EOF")
if platform == "win32":
assert err.value.args == (10054, "WSAECONNRESET")
else:
assert err.value.args == (-1, "Unexpected EOF")

def _check_client_ca_list(self, func):
"""
Expand Down