Fix go module requirements for semantic versioning

[Ntr0]

As stated in this post:
https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher
modules that released a version higher than 1 need to put the version
into the package path.

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change

/kind bug

/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:
When 2.3.0 introduced go modules, the package paths where not updated. Therefore
this module cannot be imported as version 2.3.0 since go mod will complain:

go.mod:12: require github.com/kubernetes-csi/csi-test: version "v2.3.0" invalid: module contains a go.mod file, so major version must be compatible: should be v0 or v1, not v2

Which issue(s) this PR fixes:

Fixes #231

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Update package path to v3. Vendoring with dep depends on https://github.com/golang/dep/pull/1963 or the workaround described in v3/README.md.

[k8s-ci-robot]

Hi @Ntr0. Thanks for your PR.

I'm waiting for a kubernetes-csi or kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[pohly]

This breaks vendoring csi-test with dep because of golang/dep#1962.

I don't want to force all consumers of csi-test to switch to go mod. I don't like the proposal with "Major subdirectory" from https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher either because it is so intrusive for the git history.

I came up with another solution based on symlinks, see pohly@2bc889d. I verified that this then can be imported with dep (pohly/pmem-CSI@79b03e9), albeit only with a small trick (disabling pruning for csi-test).

@Ntr0: what do you think of that approach? Can you verify that 'go modignores this new/v3` sub-directory?

If you agree that this is acceptable and works, please cherry-pick my commit into your branch.

[Ntr0]

@pohly It looks like it works. This approach seems reasonable to me, as I won't expect csi-test to maintain different versions of the package. So keeping the semantic version in the main go.mod and having these symlinks looks good to me.

[msau42]

it is so intrusive for the git history

Doesn't git mv retain history?

[msau42]

/ok-to-test

[pohly]

Michelle Au <[email protected]> writes:

> it is so intrusive for the git history Doesn't git mv retain history?

"git mv" is the same as deleting a file and adding it under a different name. It doesn't have any special support for keeping history. This is all handled when analyzing the commits: some operations detect such renames and follow them, some don't. For example, "git log v3" would stop at the commit that introduced the directory. "git log v3/pkg/sanity/sanity.go" would work.

[msau42]

Seems fine to me if the file still retains history. We rename files in k/k often. I think it's kind of messy and confusing to have symlinks

[pohly]

Seems fine to me if the file still retains history.

There are other drawbacks, like having to maintain the go.mod file also in the v3 directory. I don't know what it means for vendoring. Probably breaks our tooling and/or requires special casing.

I think it's kind of messy and confusing to have symlinks

It's an interim solution until either "dep" gets enhanced (PR is pending) or we can convince ourselves that supporting "dep" isn't necessary anymore. I prefer symlinks over messing with the directory structure.

[pohly]

If there's no consensus on how to support "dep", then I propose that we simply don't do anything special to support it, i.e. remove 0163355 from this PR again.

Then "dep" users either have to switch to "go mod" or use a patched dep version (golang/dep#1963).

[pohly]

/lgtm

[msau42]

Can you also add a release note indicating the potential future version of dep that will be needed?

[pohly]

Can you also add a release note indicating the potential future version of dep that will be needed?

It seems uncertain which version of dep will have golang/dep#1963 included; might be a patch or a major release. Better link to the PR.

[Ntr0]

@pohly Updated Release Notes to point out the breaking change for dep users

[pohly]

Updated Release Notes to point out the breaking change for dep users

Sorry for the back and forth, but when we discussed this yesterday in the Kubernetes-CSI standup meeting, @msau42 said that we should continue to support importing with normal dep. We settled on the approach with symlinks as the lesser evil.

Can you remove the revert commit from your branch and augment my commit with the following v3/README.md?

This directory mirrors the source code via symlinks.
This makes it possible to vendor v3.x releases of
csi-test with `dep` versions that do not support
semantic imports. Support for that is currently
[pending in dep](https://github.com/golang/dep/pull/1963).

If users of dep have enabled pruning, they must disable if
for csi-test in their Gopk.toml, like this:

    [prune]
      go-tests = true
      unused-packages = true

      [[prune.project]]
        name = "github.com/kubernetes-csi/csi-test"
        unused-packages = false

Can you also adapt the release note accordingly?

Thanks!

[pohly]

The double revert looks a bit weird, personally I would use git rebase -i and just drop both commits. Other than that this looks good. I'll leave the final decision to @msau42 .

[pohly]

Wait, the release note still needs to be updated:

Update package path to v3. Vendoring with dep is not supported anymore, at least until https://github.com/golang/dep/pull/1963 has been merged.

=>

Update package path to v3. Vendoring with dep depends on https://github.com/golang/dep/pull/1963 or the workaround described in v3/README.md.

[pohly]

/lgtm

There's a minor spelling nit in the README.md (my bad): "must enable it", but I propose to merge as-is to get this done.

Leaving the approval to @msau42.

/assign @msau42

[msau42]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msau42, Ntr0

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [msau42]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment