cluster-api-provider-openstack icon indicating copy to clipboard operation
cluster-api-provider-openstack copied to clipboard

Add more information to Running E2E tests locally

Open h1r0mu-nic opened this issue 3 years ago • 4 comments

/kind documentation

When I first tried to run E2E tests locally, I faced some problems such as machine spec is not enough, neutron trunking must be configured, image size have to be less than 20MB, etc.

After reading Hacking CI for the E2E tests and codes under hack/ci, everything works fine.

My suggestion is to add following items, which can be retrieved from aforementioned Hacking CI and codes, to E2E tests locally.

  • System requirements
  • Availability zones
  • Services
  • Clouds.yaml

h1r0mu-nic avatar Oct 12 '22 02:10 h1r0mu-nic

Definitely in favour of better developer documentation. Are you able to submit patches?

I think @stephenfin has also been running these locally recently. Any thoughts?

mdbooth avatar Oct 12 '22 08:10 mdbooth

I wasn't running these, I was running the https://github.com/kubernetes/cloud-provider-openstack e2e tests. I wrote a very high level doc on running there, which you can see at https://github.com/kubernetes/cloud-provider-openstack/pull/2006. Unfortunately I couldn't get more detailed because the tooling isn't there (yet) to easily run this stuff yourself by executing e.g. a script or Makefile target.

stephenfin avatar Oct 12 '22 10:10 stephenfin

Definitely in favour of better developer documentation. Are you able to submit patches?

Yes.

We thought of adding quite simple notes like I listed above, which help developers to setup OpenStack for the E2E test. If you're okey with that, I'll open PR.

h1r0mu-nic avatar Oct 12 '22 12:10 h1r0mu-nic

If you're okey with that, I'll open PR.

yes, please :) , thanks for the help~

jichenjc avatar Oct 16 '22 04:10 jichenjc