Replace ansiconv with ansi2html

[jessicamack]

SUMMARY

The ansiconv package is archived so I'm replacing it with a similar package that's still actively being worked on.

ISSUE TYPE

• Bug, Docs Fix or other nominal change

COMPONENT NAME

• Other

AWX VERSION

awx: 24.6.2

ADDITIONAL INFORMATION

[AlanCoding]

The question I'm asking myself is: do we have tests for this view?

awx/awx/main/tests/functional/api/test_unified_jobs_view.py

Lines 77 to 87 in ea23231

	@pytest.mark.parametrize("format,content_type", formats)
	@pytest.mark.django_db
	def test_job_redaction_disabled(get, format, content_type, negative_test_cases, admin):
	for test_data in negative_test_cases:
	job = test_data['job']
	response = get(reverse("api:job_stdout", kwargs={'pk': job.pk}) + "?format=" + format, user=admin, expect=200, format=format)
	content = response.data['content'] if format == 'json' else response.data
	content = smart_str(content)
	assert response.data is not None
	assert test_data['uri'].username in content
	assert test_data['uri'].password in content

awx/awx/main/tests/functional/api/test_unified_jobs_stdout.py

Lines 50 to 68 in ea23231

	@pytest.mark.django_db
	@pytest.mark.parametrize(
	'Parent, Child, relation, view',
	[
	[Job, JobEvent, 'job', 'api:job_stdout'],
	[AdHocCommand, AdHocCommandEvent, 'ad_hoc_command', 'api:ad_hoc_command_stdout'],
	[_mk_project_update, ProjectUpdateEvent, 'project_update', 'api:project_update_stdout'],
	[_mk_inventory_update, InventoryUpdateEvent, 'inventory_update', 'api:inventory_update_stdout'],
	],
	)
	def test_text_stdout(sqlite_copy, Parent, Child, relation, view, get, admin):
	job = Parent()
	job.save()
	for i in range(3):
	Child(**{relation: job, 'stdout': 'Testing {}\n'.format(i), 'start_line': i}).save()
	url = reverse(view, kwargs={'pk': job.pk}) + '?format=txt'
	response = get(url, user=admin, expect=200)
	assert smart_str(response.content).splitlines() == ['Testing %d' % i for i in range(3)]

So yes, we are generally hitting that view. And it does seem to hit the format types that would be seen.

But the assertion on the content produced is very light. I would like to see a little bit better of a confirmation. Could we just compare screens of the demo job template manually, like http://localhost:8013/api/v2/jobs/2/stdout/ does it still show the green text in the html format, for example. Does the txt format not have coloring markings at http://localhost:8013/api/v2/jobs/2/stdout/?format=txt?

[jessicamack]

@AlanCoding confirming the HTML is displaying the correct colors

[webknjaz]

If that's the only reason, it probably doesn't need to be stated here. It's usually good to set a minimum version to the release that introduced a feature being used. The compatibility with the target environment is computed by the dependency resolver when pip install is doing its thing automatically. So tracking the same information manually doesn't typically make sense unless something is really broken and needs to be excluded somehow.

Instead, it might be useful to state what uses this and how.

[webknjaz]

I checked the source code, and it seems that the released and inspectable versions of the library for the past 12 years had the same API (class+method name) so the lower boundary is indeed not necessary: https://github.com/pycontribs/ansi2html/blob/0.9.3/ansi2html/converter.py#L211. The usage info would still be nice, though.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud