Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vdk-properties-fs: new plugin for local FS properties storage #1190

Merged
merged 6 commits into from
Sep 27, 2022

Conversation

ivakoleva
Copy link
Contributor

We need a simplistic plugin, that allows a developer or presenter to quickly store secrets on the local FS during a dev/demo session, that does not require a prerequisite of the entire Control Service installed and running.

Added a FS properties client, that uses a customizable dir and filename on the local file system to store the properties key-values. It does support multiple teams and data jobs, the properties of those are placed within a dedicated section for keys deduplication.

Testing Done: added test_fs_properties_plugin.py, that covers multiple data jobs using matching keys, and default/customized directory and filename for file storage on the local FS.

Signed-off-by: ivakoleva iva.koleva@clearcode.bg

We need a simplistic plugin, that allows a developer or presenter
to quickly store secrets on the local FS during a dev/demo session,
that does not require a prerequisite of the entire Control Service
installed and running.

Added a FS properties client, that uses a customizable dir and filename
on the local file system to store the properties key-values. It does
support multiple teams and data jobs, the properties of those are placed
within a dedicated section for keys deduplication.

Testing Done: added `test_fs_properties_plugin.py`, that covers multiple
data jobs using matching keys, and default/customized directory and
filename for file storage on the local FS.

Signed-off-by: ivakoleva <iva.koleva@clearcode.bg>
@ivakoleva
Copy link
Contributor Author

Useful for workaround in cases of #1187 for example

Copy link
Contributor

@gageorgiev gageorgiev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just one small comment about the properties client.

Copy link
Collaborator

@murphp15 murphp15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Co-authored-by: Gabriel Georgiev <45939426+gageorgiev@users.noreply.github.com>
ivakoleva and others added 3 commits September 26, 2022 19:08
We need a simplistic plugin, that allows a developer or presenter
to quickly store secrets on the local FS during a dev/demo session,
that does not require a prerequisite of the entire Control Service
installed and running.

Added a FS properties client, that uses a customizable dir and filename
on the local file system to store the properties key-values. It does
support multiple teams and data jobs, the properties of those are nested
under a dedicated key for deduplication.
JSON format is used, enabling nested data structures.

Testing Done: added `test_fs_properties_plugin.py`, that covers multiple
data jobs using matching keys, and default/customized directory and
filename for file storage on the local FS.

Signed-off-by: ivakoleva <iva.koleva@clearcode.bg>
@ivakoleva ivakoleva enabled auto-merge (squash) September 26, 2022 16:11
@ivakoleva ivakoleva requested review from antoniivanov and removed request for antoniivanov September 26, 2022 16:11
Copy link
Collaborator

@antoniivanov antoniivanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Some small comments/suggestions

@ivakoleva ivakoleva merged commit fc424ce into main Sep 27, 2022
@ivakoleva ivakoleva deleted the person/ikoleva/vdk-properties-fs branch September 27, 2022 11:34
antoniivanov pushed a commit that referenced this pull request Sep 29, 2022
* vdk-properties-fs: new plugin for local FS properties storage

We need a simplistic plugin, that allows a developer or presenter
to quickly store secrets on the local FS during a dev/demo session,
that does not require a prerequisite of the entire Control Service
installed and running.

Added a FS properties client, that uses a customizable dir and filename
on the local file system to store the properties key-values. It does
support multiple teams and data jobs, the properties of those are nested
under a dedicated key for deduplication.
JSON format is used, enabling nested data structures.

Testing Done: added `test_fs_properties_plugin.py`, that covers multiple
data jobs using matching keys, and default/customized directory and
filename for file storage on the local FS.

Signed-off-by: ivakoleva <iva.koleva@clearcode.bg>

Signed-off-by: ivakoleva <iva.koleva@clearcode.bg>
Co-authored-by: Gabriel Georgiev <45939426+gageorgiev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants