Re: [openstack-dev] Divergence of *-specs style checking
Yuriy Taraday said on Tue, May 20, 2014 at 01:37:29PM +0400: > On Mon, May 19, 2014 at 8:38 PM, Alexis Lee wrote: > > Potentially the TITLES structure could > > be read from a per-project YAML file and the test itself could be drawn > > from some common area? > > I think you can get that data from template.rst file by parsing it and > analyzing the tree. Excellent suggestion! I've raised https://review.openstack.org/94380 and https://review.openstack.org/94381 . Nova-specs seems the right starting place for a shared version as it's where it all began and they have a couple of tests Neutron + TripleO currently lack. Alexis -- Nova Engineer, HP Cloud. AKA lealexis, lxsli. ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Divergence of *-specs style checking
Great idea! On Mon, May 19, 2014 at 8:38 PM, Alexis Lee wrote: > Potentially the TITLES structure could > be read from a per-project YAML file and the test itself could be drawn > from some common area? > I think you can get that data from template.rst file by parsing it and analyzing the tree. -- Kind regards, Yuriy. ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Divergence of *-specs style checking
On Mon, May 19, 2014 at 9:38 AM, Alexis Lee wrote: > We're seeing the spread of various *-specs projects now, which is great > to see. Some of these (nova, neutron and tripleo) include a Python unit > test (tests/test_titles.py) to check the specs follow the template. The > test has been copy-pasted between projects and it's diverging already. > Nova has a couple of extra tests; Neutron has some custom directives; > TripleO disallows additional sections. > > It seems reasonable that while the specific allowed sections and > subsections may vary, the general guidance should apply across all > OpenStack projects much as code shares HACKING. > > I put up a review here: https://review.openstack.org/#/c/91801/ > which makes it more data-driven. Potentially the TITLES structure could > be read from a per-project YAML file and the test itself could be drawn > from some common area? > This sounds like a good idea, standardizing tooling across different projects is one of the key items that has helped OpenStack development scale and make it easy for developers to switch between projects. > > > Alexis > -- > Nova Engineer, HP Cloud. AKA lealexis, lxsli. > > ___ > OpenStack-dev mailing list > OpenStack-dev@lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] Divergence of *-specs style checking
I've also put up the following which is based on a tool that has been use in taskflow. http://pypi.python.org/pypi/doc8 And inclusion into stackforge (getting it off my github repo). https://review.openstack.org/#/c/94236/ Seems like we can do some of these rules in it. Its pluggable via stevedore[1] so shouldn't be to hard to add custom checks. [1] https://github.com/harlowja/doc8/blob/master/doc8/main.py#L94 -Original Message- From: Alexis Lee Reply-To: "OpenStack Development Mailing List (not for usage questions)" Date: Monday, May 19, 2014 at 9:38 AM To: "OpenStack Development Mailing List (not for usage questions)" Subject: [openstack-dev] Divergence of *-specs style checking >We're seeing the spread of various *-specs projects now, which is great >to see. Some of these (nova, neutron and tripleo) include a Python unit >test (tests/test_titles.py) to check the specs follow the template. The >test has been copy-pasted between projects and it's diverging already. >Nova has a couple of extra tests; Neutron has some custom directives; >TripleO disallows additional sections. > >It seems reasonable that while the specific allowed sections and >subsections may vary, the general guidance should apply across all >OpenStack projects much as code shares HACKING. > >I put up a review here: https://review.openstack.org/#/c/91801/ >which makes it more data-driven. Potentially the TITLES structure could >be read from a per-project YAML file and the test itself could be drawn >from some common area? > > >Alexis >-- >Nova Engineer, HP Cloud. AKA lealexis, lxsli. > >___ >OpenStack-dev mailing list >OpenStack-dev@lists.openstack.org >http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
[openstack-dev] Divergence of *-specs style checking
We're seeing the spread of various *-specs projects now, which is great to see. Some of these (nova, neutron and tripleo) include a Python unit test (tests/test_titles.py) to check the specs follow the template. The test has been copy-pasted between projects and it's diverging already. Nova has a couple of extra tests; Neutron has some custom directives; TripleO disallows additional sections. It seems reasonable that while the specific allowed sections and subsections may vary, the general guidance should apply across all OpenStack projects much as code shares HACKING. I put up a review here: https://review.openstack.org/#/c/91801/ which makes it more data-driven. Potentially the TITLES structure could be read from a per-project YAML file and the test itself could be drawn from some common area? Alexis -- Nova Engineer, HP Cloud. AKA lealexis, lxsli. ___ OpenStack-dev mailing list OpenStack-dev@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
