[neutron]: introduce Stateful argument for the security groups - #3092

coverage: 78.742% (+0.005%) from 78.737%
when pulling 2b979bf on kayrus:secgroup-stateful
into 71268a5 on gophercloud:master.

Since this is a breaking API change, I wonder if we shouldn't document it right away and explain the migration in MIGRATING.md or something cc @stephenfin @pierreprinetti

@EmilienM hm, this is not a breaking change. The change is absolutely backwards compatible.

@EmilienM hm, this is not a breaking change. The change is absolutely backwards compatible.

We changed the signature of List() to take a ListOptsBuilder rather than a ListOpts.

You can check the output of go-apidiff, with what seems like a small reporting issue:

github.com/gophercloud/gophercloud/v2/openstack/networking/v2/extensions/security/groups
  Incompatible changes:
  - ListOpts: changed from ListOpts to ListOpts
  Compatible changes:
  - CreateOpts.Stateful: added
  - ListOptsBuilder: added
  - SecGroup.Stateful: added
  - UpdateOpts.Stateful: added'

@mandre since ListOpts completely satisfies the new ListOptsBuilder, from my perspective this is backwards compatible. So new dependency will compile with the app, which was previously compiled with an old dependency.

@mandre since ListOpts completely satisfies the new ListOptsBuilder, from my perspective this is backwards compatible. So new dependency will compile with the app, which was previously compiled with an old dependency.

Right, so this could be a bug in go-apidiff.

Labels semver-major or semver-unknown can not trigger backports.
The PR has to be labeled semver-patch or semver-minor.

Merging this PR means that we now need a v2 branch and the related backport machinery! 😅
@mandre @EmilienM @kayrus

@kayrus

@mandre since ListOpts completely satisfies the new ListOptsBuilder, from my perspective this is backwards compatible. So new dependency will compile with the app, which was previously compiled with an old dependency.

You changed a function signature, which means that you're breaking a statement like this one:

var myFunc func(*gophercloud.ServiceClient, secgroup.ListOpts) = secgroup.List

@pierreprinetti haven't thought about this, but fair enough. However it's not clear in how many places you can see such patterns.

@pierreprinetti shall I revert this PR?

it's not clear in how many places you can see such patterns

You'd be surprised. cluster-api-provider-openstack for example wraps all Gophercloud calls into custom interfaces, so that it can mock its logic.

@pierreprinetti shall I revert this PR?

I don't think so. But if you want to use stateful in v2 or v1, you'll have to make custom backport PRs without the ListOpts change. and before that, we need to set up the v2 branch and associated machinery

@pierreprinetti I'm going to create a v2 branch with a corresponding backport automation.