Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
GitPython/gitdb/gitdb/test/test_stream.py at main · gitpython-developers/GitPython · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
gitpython-developers
/
GitPython
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
995
Star
5.2k
Code
Issues
8
Pull requests
2
Discussions
Actions
Security and quality
35
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
GitPython
/
gitdb
/
gitdb
/
test
/
test_stream.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
200 lines (166 loc) · 7.18 KB
main
Breadcrumbs
GitPython
/
gitdb
/
gitdb
/
test
/
test_stream.py
Copy path
Top
File metadata and controls
Code
Blame
200 lines (166 loc) · 7.18 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# Copyright (C) 2010, 2011 Sebastian Thiel (byronimo@gmail.com) and contributors
#
# This module is part of GitDB and is released under
# the New BSD License: https://opensource.org/license/bsd-3-clause/
"""Test for object db"""
from
gitdb
.
test
.
lib
import
(
TestBase
,
DummyStream
,
make_bytes
,
make_object
,
fixture_path
)
from
gitdb
import
(
DecompressMemMapReader
,
FDCompressedSha1Writer
,
LooseObjectDB
,
Sha1Writer
,
MemoryDB
,
IStream
,
)
from
gitdb
.
util
import
hex_to_bin
import
zlib
from
gitdb
.
typ
import
(
str_blob_type
)
import
tempfile
import
os
from
io
import
BytesIO
class
TestStream
(
TestBase
):
"""Test stream classes"""
data_sizes
=
(
15
,
10000
,
1000
*
1024
+
512
)
def
_assert_stream_reader
(
self
,
stream
,
cdata
,
rewind_stream
=
lambda
s
:
None
):
"""Make stream tests - the orig_stream is seekable, allowing it to be
rewound and reused
:param cdata: the data we expect to read from stream, the contents
:param rewind_stream: function called to rewind the stream to make it ready
for reuse"""
ns
=
10
assert
len
(
cdata
)
>
ns
-
1
,
"Data must be larger than %i, was %i"
%
(
ns
,
len
(
cdata
))
# read in small steps
ss
=
len
(
cdata
)
//
ns
for
i
in
range
(
ns
):
data
=
stream
.
read
(
ss
)
chunk
=
cdata
[
i
*
ss
:(
i
+
1
)
*
ss
]
assert
data
==
chunk
# END for each step
rest
=
stream
.
read
()
if
rest
:
assert
rest
==
cdata
[
-
len
(
rest
):]
# END handle rest
if
isinstance
(
stream
,
DecompressMemMapReader
):
assert
len
(
stream
.
data
())
==
stream
.
compressed_bytes_read
()
# END handle special type
rewind_stream
(
stream
)
# read everything
rdata
=
stream
.
read
()
assert
rdata
==
cdata
if
isinstance
(
stream
,
DecompressMemMapReader
):
assert
len
(
stream
.
data
())
==
stream
.
compressed_bytes_read
()
# END handle special type
def
test_decompress_reader
(
self
):
for
close_on_deletion
in
range
(
2
):
for
with_size
in
range
(
2
):
for
ds
in
self
.
data_sizes
:
cdata
=
make_bytes
(
ds
,
randomize
=
False
)
# zdata = zipped actual data
# cdata = original content data
# create reader
if
with_size
:
# need object data
zdata
=
zlib
.
compress
(
make_object
(
str_blob_type
,
cdata
))
typ
,
size
,
reader
=
DecompressMemMapReader
.
new
(
zdata
,
close_on_deletion
)
assert
size
==
len
(
cdata
)
assert
typ
==
str_blob_type
# even if we don't set the size, it will be set automatically on first read
test_reader
=
DecompressMemMapReader
(
zdata
,
close_on_deletion
=
False
)
assert
test_reader
.
_s
==
len
(
cdata
)
else
:
# here we need content data
zdata
=
zlib
.
compress
(
cdata
)
reader
=
DecompressMemMapReader
(
zdata
,
close_on_deletion
,
len
(
cdata
))
assert
reader
.
_s
==
len
(
cdata
)
# END get reader
self
.
_assert_stream_reader
(
reader
,
cdata
,
lambda
r
:
r
.
seek
(
0
))
# put in a dummy stream for closing
dummy
=
DummyStream
()
reader
.
_m
=
dummy
assert
not
dummy
.
closed
del
(
reader
)
assert
dummy
.
closed
==
close_on_deletion
# END for each datasize
# END whether size should be used
# END whether stream should be closed when deleted
def
test_sha_writer
(
self
):
writer
=
Sha1Writer
()
assert
2
==
writer
.
write
(
b"hi"
)
assert
len
(
writer
.
sha
(
as_hex
=
1
))
==
40
assert
len
(
writer
.
sha
(
as_hex
=
0
))
==
20
# make sure it does something ;)
prev_sha
=
writer
.
sha
()
writer
.
write
(
b"hi again"
)
assert
writer
.
sha
()
!=
prev_sha
def
test_compressed_writer
(
self
):
for
ds
in
self
.
data_sizes
:
fd
,
path
=
tempfile
.
mkstemp
()
ostream
=
FDCompressedSha1Writer
(
fd
)
data
=
make_bytes
(
ds
,
randomize
=
False
)
# for now, just a single write, code doesn't care about chunking
assert
len
(
data
)
==
ostream
.
write
(
data
)
ostream
.
close
()
# its closed already
self
.
assertRaises
(
OSError
,
os
.
close
,
fd
)
# read everything back, compare to data we zip
fd
=
os
.
open
(
path
,
os
.
O_RDONLY
|
getattr
(
os
,
'O_BINARY'
,
0
))
written_data
=
os
.
read
(
fd
,
os
.
path
.
getsize
(
path
))
assert
len
(
written_data
)
==
os
.
path
.
getsize
(
path
)
os
.
close
(
fd
)
assert
written_data
==
zlib
.
compress
(
data
,
1
)
# best speed
os
.
remove
(
path
)
# END for each os
def
test_decompress_reader_special_case
(
self
):
odb
=
LooseObjectDB
(
fixture_path
(
'objects'
))
mdb
=
MemoryDB
()
for
sha
in
(
b'888401851f15db0eed60eb1bc29dec5ddcace911'
,
b'7bb839852ed5e3a069966281bb08d50012fb309b'
,):
ostream
=
odb
.
stream
(
hex_to_bin
(
sha
))
# if there is a bug, we will be missing one byte exactly !
data
=
ostream
.
read
()
assert
len
(
data
)
==
ostream
.
size
# Putting it back in should yield nothing new - after all, we have
dump
=
mdb
.
store
(
IStream
(
ostream
.
type
,
ostream
.
size
,
BytesIO
(
data
)))
assert
dump
.
hexsha
==
sha
# end for each loose object sha to test
def
test_decompress_reader_chunked_read_does_not_terminate_early
(
self
):
"""Regression test for #120: read(N) must not return b'' before EOF.
zlib can consume input without producing decompressed output (e.g.
while ingesting block headers). The reader's internal recursion
previously bailed on any empty zip output, so a caller reading in
small chunks via the standard `while chunk := stream.read(N)` idiom
would terminate at the first empty chunk -- before the actual end
of the uncompressed stream.
"""
# Highly compressible data exposes the bug because each zlib chunk
# spans many uncompressed bytes -- intermediate decompress() calls
# often return empty while consuming input.
data
=
b"hello world! "
*
1000
zdata
=
zlib
.
compress
(
data
)
# Loop with a small chunk size to force many internal read/decompression
# iterations before EOF.
for
chunk_size
in
(
1
,
4
,
16
,
64
):
reader
=
DecompressMemMapReader
(
zdata
,
close_on_deletion
=
False
,
size
=
len
(
data
)
)
out
=
bytearray
()
while
True
:
chunk
=
reader
.
read
(
chunk_size
)
if
not
chunk
:
break
out
.
extend
(
chunk
)
assert
bytes
(
out
)
==
data
, (
f"chunk_size=
{
chunk_size
}
: got
{
len
(
out
)
}
/
{
len
(
data
)
}
bytes"
)
assert
reader
.
_br
==
reader
.
_s
, (
f"chunk_size=
{
chunk_size
}
: stream stopped at "
f"
{
reader
.
_br
}
/
{
reader
.
_s
}
"
)
You can’t perform that action at this time.