Feat/add flavor page

[garloff]

Code for PoC for SovereignCloudStack/issues#483

Totally Web 1.0, that's my generation ...

[berendt]

Works for me. I already added it to the flavor manager docs:

https://osism.github.io/docs/guides/operations-guide/openstack/flavor-manager/#name-parser-and-generator

[mbuechse]

Nice! From my POV, two things should be improved though:

• the script should output valid HTML; to that end, it could read the index.html and insert its output into some conveniently marked (easy to find) position
• the error messages should also be improved; all I got at first try was TypeError: cannot unpack non-iterable NoneType object -- it could at least say "The cause is probably that the name given is not a valid SCS flavor name"

As always, I volunteer to implement these or similar improvements.

[garloff]

Nice! From my POV, two things should be improved though:

* the script should output valid HTML; to that end, it could read the index.html and insert its output into some conveniently marked (easy to find) position

I had this on my list as well.
I would actually generate the main page from the script and embed the flavor parser (and later flavor generator) output in it. Maybe using some simple templating with zope or so would make this easy.
I also need to replace the cgi module with urllib.

* the error messages should also be improved; all I got at first try was `TypeError: cannot unpack non-iterable NoneType object` -- it could at least say "The cause is probably that the name given is not a valid SCS flavor name"

For some wrong flavors you do get useful hints where the parser failed, for some you don't.
My guess is that there are a few things that you can easily improve in the existing implementation, but I would be surprised if you are able to output meaningful error messages in all cases without adding a lot of error handling code.

An option is of course to use some open source tooling that is meant to support syntax parsing rather than coding it yourself. I had a quick check back then and decided that coming up with my own is easier. But that may have been due to insufficient research.

If you go there, we'd have a second independent implementation of the flavor spec, which may help with testing.

As always, I volunteer to implement these or similar improvements.

I would want to take the easy steps (using templating to generate good HTML) quickly but then do a first merge.
The more tedious error message improvements can always come in a second step.
Oh, and of course if someone wants to use less antique Web1.0 technology ...

[garloff]

So, this should be producing good HTML now.
It also outputs "non-SCS flavor" for flavors not starting with SCS-.
Next step will be to support flavor name generation, but that needs a somewhat complex form, which I can't do in a few minutes ... so I'd like this one to be merged. Reviews welcome!

[berendt]

I think we can merge this AS-IS in a first step. This can be improved and beautified in a 2nd step. Same with the generator.

[berendt]

Should be AGPLv3 for code?

[garloff]

All code in this directory is CC-BY-SA-4.0, which is a weak copyleft license.

CC is not a good license for compiled code, as it does not have any provisions for source code availability when distributing binary code. That is not a problem for scripting languages ...

[mbuechse]

I'm not sure if one could distribute pyc files. I guess it would probably be a hassle for everyone.

[mbuechse]

Overall fine, only very minor things in the comments.

Plus: could you add some snippet documenting how you integrated the cgi script into the website? Some config for nginx or Apache?

[mbuechse]

Maybe we should add that the functionality of the website is analogous to some of the scripts mentioned above (and in what way).

[garloff]

"The flavor name parsing and (soon) flavor name generation of these scripts is also exposed via the web page https://flavors.scs.community/."

[mbuechse]

Shall we get rid of the imports that are commented out?

[garloff]

Those were required before but have been replaced ...
Feel free to push a change to remove them.

[joshmue]

For future reference: There was a injection bug here that's fixed in #403 and #404.