feat: redact credentials in remote urls

[pd93]

Fixes #2100 and replaces #2045

Ensures that any credentials embedded in the URL are redacted by using the built in url.Redacted() function. The cache keys have also been altered slightly, so users may have to redownload some files that they already have cached.

[pd93]

@iwittkau, very open to comments as you were the author of the last PR.

[iwittkau]

I think this test should be added an pass:

func TestGitNode_redaction(t *testing.T) {
	t.Parallel()

	node, err := NewGitNode("https://git:[email protected]/foo/bar.git//directory/Taskfile.yml?ref=main", "", false)
	assert.NoError(t, err)
	assert.Equal(t, "main", node.ref)
	assert.Equal(t, "directory/Taskfile.yml", node.path)
	assert.Equal(t, "https://git:[email protected]/foo/bar.git//directory/Taskfile.yml?ref=main", node.Location())
	// assert.Equal(t, "https://git:[email protected]/foo/bar.git", node.URL.String())
	entrypoint, err := node.ResolveEntrypoint("common.yml")
	assert.NoError(t, err)
	assert.Equal(t, "https://git:[email protected]/foo/bar.git//directory/common.yml?ref=main", entrypoint)
}

[iwittkau]

Nice! 🎉

I'll give it a try with my work setup tomorrow.

[iwittkau]

I think you could keep GitNode.URL unexported to make sure its String and Redacted funcs are called correctly.

[pd93]

I think you could keep GitNode.URL unexported to make sure its String and Redacted funcs are called correctly.

Yeah, we don't really need any of the properties on Node implementations to be exported. They have constructors and they're quite bespoke. Package API users can just roll their own Nodes if they need custom behavior. I have unexported all Node fields.

[iwittkau]

@pd93 I just noticed that this branch needs a go mod tidy.

[vmaerten]

The is cache naming is way better like this!

[vmaerten]

lgtm ! gj :)

[iwittkau]

I've been using this for a while now and it works nicely 👍🏻