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

clean up temp file after run #9356

Merged
merged 2 commits into from
Jan 8, 2020
Merged
Changes from 1 commit
Commits
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
22 changes: 13 additions & 9 deletions sdk/core/azure-core/tests/test_retry_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
HttpResponse,
HttpTransport,
)
import uuid
import os

def test_retry_code_class_variables():
retry_policy = RetryPolicy()
Expand Down Expand Up @@ -141,17 +143,19 @@ def send(self, request, **kwargs): # type: (PipelineRequest, Any) -> PipelineRe
assert not position
return HttpResponse(request, None)

file_name = 'test_retry_seekable_file'
file_name = str(uuid.uuid4())
with open(file_name, "w+") as f:
f.write('Lots of dataaaa')
http_request = HttpRequest('GET', 'http://127.0.0.1/')
headers = {'Content-Type': "multipart/form-data"}
http_request.headers = headers
form_data_content = {
'fileContent': open(file_name, 'rb'),
'fileName': file_name,
}
http_request.set_formdata_body(form_data_content)
http_retry = RetryPolicy(retry_total = 1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
with open(file_name, 'rb') as f:
form_data_content = {
'fileContent': f,
'fileName': file_name,
}
http_request.set_formdata_body(form_data_content)
http_retry = RetryPolicy(retry_total=1)
pipeline = Pipeline(MockTransport(), [http_retry])
pipeline.run(http_request)
os.remove(file_name)
Copy link
Contributor

Choose a reason for hiding this comment

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

Would with tempfile.NamedTemporaryFile work here? If it does, it would clean up after itself

Copy link
Member Author

Choose a reason for hiding this comment

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

If I understand correctly, tempfile will be removed automatically after close. Hence it will be gone after
with open(file_name, "w+") as f:
f.write('Lots of dataaaa')?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure, but couldn't that write occur in the tempfile with block as the first action?

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 is a good question. And in fact I purposely separate them. :)

My thought is

file_name = str(uuid.uuid4())
with open(file_name, "w+") as f:
f.write('Lots of dataaaa')

are the test preparation steps and after that are real test scenario. I don't want to mix them though I don't think it will impact the results.

Copy link
Contributor

Choose a reason for hiding this comment

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

I wish the docs were more clear about this. They state:

Whether the name can be used to open the file a second time, while the named temporary file is still open, varies across platforms

Which actually leads me to believe that using NamedTemporaryFile to create a file which you write data to and then close, would be OK to open again later. That might be preferable to saving a file with a UUID filename in the current dir. There are definitely cases where writing the file might fail (non-writable curdir) or deleting may fail (an exception in the test) leaving junk in the repo (which always risks being checked in by mistake).

Which I guess raises another avenue: why not just check in a sample data file in to the test directory?

Copy link
Member Author

Choose a reason for hiding this comment

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

tempfile has a delete parameter which is exactly what we want. update the case to use tempfile