PMR: Remove access to stale Profiles with create_or_update_profiles()

[kimwnasptd]

Closes #9

First part of working on the create_or_udpate_profiles function. There will be follow-up PRs for the rest of the functionality of that function, but for now I focused on breaking it to smaller PRs.

Changes

1. Added helpers for manipulating k8s objects
2. Started the main create_or_update_profiles(pmr) function
3. Added integration tests for the create_or_update_profiles(pmr). For now I have one file, but we can break it to multiple as we go

Review Notes

You can test the code by running tox -e integration-library.

There is a bit of duplication between the testing helper functions and the helper functions of the library. I've kept them separate, as it's a bad practice to use utility function from the main logic that is tested from the test scripts.

Lastly, while in the future the function's signature will slightly change, to take into consideration the principals, for now I haven't included them (as they also collide with lint)

[mvlassis]

Made a first pass, mainly correcting grammar mistakes.

I like the splitting of the files and the small functions, but I'm not sure about the names of the files/directories.

• Maybe the yamls directory could be renamed to example-yaml to be more descriptive.
• Not sure about the name of conftest.py
• The helpers k8s.py, kfam.py, profiles.py could have more descriptive names as well, maybe appending -helpers?
• I don't think the name create.py fits as well, maybe create_or_update.py is better

[kimwnasptd]

Thanks for the review @mvlassis! Regarding the names, indeed naming is always a bit tough.

• I personally liked yamls as it was concise, what if we do templated_yamls? Since they are not really example yamls
• conftest is something defined by pytest for sharing fixtures across tests "automagically"
• Regarding the helpers, I agree, but to avoid adding the -helers I moved all files under the helpers folder/module. WDYT?
• Don't have a hard preference on create.py to be create_or_update.py

Let's also get feedback from @DnPlas and we can go with the naming that seems more easy to understand for all of us, and I'll make a commit

[DnPlas]

Thanks @kimwnasptd !

Did a first pass on the create.py file. I think some of my comments may re-shape this PR, so after your consideration and possible update, I can do a second pass on the rest of the files.

[kimwnasptd]

I also had to push a commit to address canonical/bundle-kubeflow#1178 and canonical/charmcraft#2023 cc @mvlassis

38ad649

[mvlassis]

@kimwnasptd

• I think template_yamls seems good, although feel free to use yamls, I don't have any strong feelings on that one
• The name for conftest.py makes a lot of sense with the context, thanks!
• I like moving the helpers to their own repository!

[DnPlas]

Thanks @kimwnasptd, lgtm. Let's also ask @mvlassis for his approval.