gh-131178: Add tests for http.server command-line interface

[ggqlq]

#131178

• Issue: Add tests for command-line interface #131178

[python-cla-bot]

All commit authors signed the Contributor License Agreement.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[donBarbos]

I haven't read everything carefully yet, but this is what catches my eye first

[ggqlq]

Should we remove the test_cgi_flag function? The --cgi flag will be removed in version 3.15 according to the documentation.

[donBarbos]

Should we remove the test_cgi_flag function? The --cgi flag will be removed in version 3.15 according to the documentation.

I don't think we should remove it until PR #133811 is merged.

[picnixz]

You can remove them. I don't think it's worth for a test to stay if I'm going to remove it just after. However, you shouldn't remove it from the runtime (namely, don't change the current behavior, you just don't need to bother with creating the tests). This will be part of my PR.

We didn't backport the additional tests, so in 3.15, there shouldn't be code using CGI.

[picnixz]

Suggested change

	proc = spawn_python('-u', '-m', 'http.server', str(port), '-b', bind,
	'--tls-cert', self.tls_cert,
	'--tls-key', self.tls_key,
	'--tls-password-file', self.tls_password_file,
	bufsize=1, text=True)
	self.assertTrue(self.wait_for_server(proc, 'https', port, bind))
	res = self.fetch_file(f'https://{bind}:{port}/{self.random_file_name}')
	self.assertEqual(res, self.random_data)
	proc.terminate()
	kill_python(proc)
	proc = spawn_python('-u', '-m', 'http.server', str(port), '-b', bind,
	'--tls-cert', self.tls_cert,
	'--tls-key', self.tls_key,
	'--tls-password-file', self.tls_password_file,
	bufsize=1, text=True)
	self.addCleanup(proc.terminate)
	self.addCleanup(kill_python, proc)
	self.assertTrue(self.wait_for_server(proc, 'https', port, bind))
	res = self.fetch_file(f'https://{bind}:{port}/{self.random_file_name}')
	self.assertEqual(res, self.random_data)

Hopefully, it will first call proc.terminate before calling kill_python(proc).

[picnixz]

Ditto

[picnixz]

Let's capture the output outside invoke_httpd as well:

def invoke_httpd(self, *args, stdout=None, stderr=None):
    stdout = StringIO() if stdout is None else stdout
    stderr = StringIO() if stderr is None else stderr
    with contextlib.redirect_stdout(stdout), \
        contextlib.redirect_stderr(stderr):
        server._main(args)
    return {'stdout': stdout.getvalue(), 'stderr': stderr.getvalue()}

Then do:

stdout, stderr = StringIO(), StringIO()
with self.assertRaises(SystemExit):
    _ = self.invoke_httpd('--unknown-flag', stdout=stdout, stderr=stderr)
self.assertEqual(stdout.getvalue(), "")
self.assertIn("error: ", stderr.getvalue())