While reading some of the documentation in the Interop Github repo
I found a few typos in the docs and thought I'd fix them upstream.
Change-Id: If7ff117e6634c1ceac19591d2b78844bd398681d
At the Board of Directors meeting on April 24, 2016 the Board of
Directors indicated that as DefCore has evolved it's focus on
interoperability and it's working structure, it's name may be a source
of some confusion to those outside of the community or who are new to
the community. The Board made an informal request that the DefCore
Committee consider changing it's name to more clearly reflect it's focus
and structure.
This patch is the first step in that process. It updates references
in various documents to change the name "DefCore Committee" to
"Interop Working Group" as agreed at the summer 2016 DefCore Committee
Sprint [1].
It should be noted that this patch should be considered a work in
progress to generate discussion until the new name is approved by
the DefCore Committee and the Board of Directors. Should we elect
to go forward with the new name, some other actions will also need
to be taken, including but not limited to:
1. We will need to consider updating references on the OpenStack wiki.
2. We will need to consider updating the name of our IRC channel,
mailing list, Launchpad project, and git repository. Most of these
changes will need to be carefully coordinated with the OpenStack
Infrastructure team.
3. We will need to take into account external resources that point to
DefCore artifacts, such as Foundation-maintained websites (such as:
http://www.openstack.org/interop ).
4. We will need to coordinate with RefStack to minimize impact.
5. We will need to clearly communicate the name change to the rest of the
community.
Note also that I've intentionally left many historical documents that
have been superceded (such as the 2015A process docs, Guidelines that
are no longer used, etc) in tact. There seemed little value in
spending time on them and cluttering the patch with them since they're
now obsolete.
[1] https://etherpad.openstack.org/p/DefCoreSummer2016Sprint
Change-Id: I79d337c193e75c54d49f1d847468f6347e2ef2b3
It's now come up a couple of times that we've found people modifying
tests in order to pass them. Although seems obvious that not testing
things the same way across all clouds voids any guarantee of
interoperability, we should make this explit in the guidance we provide.
It's been proposed that one reason folks may be modifying tests is that
they don't clearly understand what they need to do in order to file a
flag request when they run into a problem, so they try to fix what they
think is wrong with the test instead.
This patch makes three changes to help address the issue:
1.) It adds a section to the 2016.01 guidance (which is currently
linked to from http://openstack.org/interop) to make it explicitly
clear that tests shouldn't be modified.
2.) Assuming that the interop website will be updated to point to the
most recent Guideline at some point, it creates the same guidance for
2016.08.
3.) It ammends HACKING to include simple instructions and an example
of how to file a flag request. The individual guidelines' guidance
files also point to HACKING so folks know to look there.
Change-Id: I2f57a852da3181714e87d8e689dd5a1cb33cb417
Flag tests that have been removed from the Tempest test
suite[1]. Capabilities are covered by other tests. Tests
to be permanently removed from future guidelines.
compute-auth-* capabilities removed because of empty
test sets.
[1] https://review.openstack.org/#/c/271467
Change-Id: Ib6b8ca03f39c7590163a9db710e5ca8aa373d659
in new guidelines. This HACKING rule will ensure that all tests
in guidelines are added by intent and not accidently carried
from the next.json file.
Change-Id: I11ab2ec8f0f79fe4c0f114d61eed35b1d7f318dc
This was discussed at the Flag.2 meeting [1] where the
included initial suggestions were made. The intent is to
start a discussion using this patch about the flagging process
where we can establish clear and transparent criteria.
[1] https://etherpad.openstack.org/p/DefCoreFlag.2
Co-authored-by: Rob Hirschfeld <rob@zehicle.com>
Co-authored-by: Mark T. Voelker <mvoelker@vmware.com>
Co-authored-by: Jim Meyer <jim@geekdaily.org>
Change-Id: Ieacf8f8b4307658392a21f57cb1a2031e3573383
In fd6aca6 [1] we changed rule D302 in HACKING so that tests which
never met DefCore criteria in the first place could never be removed
from the .next.json file (meaning that the flag would stay in place
indefinitely and the test would be re-evaluated at the start of
every DefCore cycle forever). Per discussion at the Flag.3 meeting [2],
it seems that many Committee members feel that this was an oversite
during review and that it would preferable for such tests to be removed
in the interest of reducing clutter and avoiding spending a lot of
cycles re-evaluating an ever-growing list of tests that are unlikely to
ever meet DefCore criteria. This patch re-inroduces the clause allowing
such tests to be removed.
[1] https://review.openstack.org/#/c/185158/
[2]
http://eavesdrop.openstack.org/meetings/defcore/2015/defcore.2015-06-11-01.02.html
Change-Id: Id63956e9679562ad2c2ee5ec6b6d49cc80dfa6f0
Upon review, we found that we do NOT need breaking changes to the
schema. In this minor revision, we are adding keys and placing
forward references to the new keys from the old ones.
At this point, we've removed the tests as per 2015.05 guideline.
These will be added back over time.
SUMMARY:
added: reference
added: tests-repositories
added: required-since
added: tests now have block including idempotent_id and (optional) flagged information
change: guidelines to point to required-since
change: tests from array to hash
change: add hash after test-name keys
change: flagged points to new location tests/test-name/flagged
change: new version 1.3
To match the reference field, added new schema.1.3.rst file with
explanation of the json schema. This file was expanded to include
items that were added in 1.2 but not documented.
The schema.1.2.rst file was added to preserve the json schema
removed from the README.rst file. It was not otherwise changed.
Expanded HACKING file to capture flagging mechanics.
Co-Authored-By: Rob Hirschfeld <rob@zehicle.com>
Co-Authored-By: Chris Hoge <chris@openstack.org>
Co-Authored-By: Mark T. Voelker <mvoelker@vmware.com>
Change-Id: I61483f988bdb1f4deb18266f611044b24ba65c34
As we receive more submissions to flag or add tests, it's important
for contributors to know how to submit modifications to the guidelines.
In other OpenStack projects, HACKING files are used to denote "rules of
the road" for contributions. The rules lists laid out in HACKING files
and the automation around enforcement of the rules ostensibly reduce
patch iterations (and thus reviewer workload) and speed up acceptance
of patches by giving contributors insight into the conventions the project
uses before submitting a patch.
This patch adds a HACKING.rst file for the DefCore repository which
provides rules for incoming changes in order to make contributor's
lives easier.
Change-Id: I21f21385f3e51d228d2a8fbf48eb904b6066c0cf
Martin Kopec