add machineset resource implementation #97

GuyAfik · 2021-08-09T13:44:56Z

This patch adds the abilty to create the 'machineset' resource.

Short description:

More details:

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewer:

Bug:

ocp_resources/machineset.py

myakove · 2021-08-09T13:57:46Z

ocp_resources/machineset.py

+
+    def to_dict(self):
+
+        data = super().to_dict()


please rename data to res, keep our code the same in all resources.

ocp_resources/machineset.py

myakove · 2021-08-09T14:01:32Z

ocp_resources/machineset.py

+            "labels",
+            "template",
+        )
+        _provider_spec = "providerSpec"


Why this one is separated from the above?

apparently the pre-commit changed that before my commit, ill change that.

ocp_resources/machineset.py

myakove · 2021-08-09T14:04:38Z

ocp_resources/machineset.py

@@ -0,0 +1,91 @@
+from ocp_resources.machine import NamespacedResource


Please import from resource

myakove · 2021-08-09T14:08:23Z

ocp_resources/machineset.py

+            f"{self.api_group}/cluster-api-machine-type": self.machine_type,
+        }
+
+        data.setdefault(_spec, {})


data.setdefault(_spec, {}) data[_spec]["replicas"] = self.replicas

can be done in one line

myakove · 2021-08-09T14:08:35Z

ocp_resources/machineset.py

+
+        data.setdefault(_spec, {})
+        data[_spec]["replicas"] = self.replicas
+        data[_spec].setdefault(_selector, {})


myakove · 2021-08-10T12:14:01Z

ocp_resources/machineset.py

+            "providerSpec",
+        )
+
+        res[_metadata].setdefault(


res[_metadata].setdefault(_labels, {}).update( { f"{self.api_group}/cluster-api-cluster": self.cluster_name, f"{self.api_group}/cluster-api-machine-role": self.machine_role, f"{self.api_group}/cluster-api-machine-type": self.machine_type, }, })

what's the difference between those two statements?

res[_metadata].setdefault(
_labels,
{
f"{self.api_group}/cluster-api-cluster": self.cluster_name,
f"{self.api_group}/cluster-api-machine-role": self.machine_role,
f"{self.api_group}/cluster-api-machine-type": self.machine_type,
},
)

This statement will only overrun the labels in case the "lables" key does not appear in the dict.
So if the user applied its own labels then i will not overrun it.

you want to update the existing one if any.

myakove · 2021-08-11T09:35:32Z

ocp_resources/machineset.py

+            }
+        )
+        res.setdefault(
+            _spec,


ditto, use update()

myakove

.

rnetser · 2021-08-12T07:38:03Z

ocp_resources/machineset.py

+
+        res[_metadata].setdefault(_labels, {}).update(
+            {
+                f"{self.api_group}/cluster-api-cluster": self.cluster_name,


cluster-api-cluster please save and re-use (applies to all those which are used more than once)

How about saving all in one dict and use dict comprehension to add only the relevant data in each case?

ack

can you share an example of what you mean?

myakove · 2021-08-15T07:23:58Z

ocp_resources/machineset.py

+
+        res.setdefault(_spec, {}).update(
+            {
+                "replicas": self.replicas,


you need setdefault with update for each one.
replicas
selector and so on

ack, updated

myakove · 2021-08-17T08:31:35Z

ocp_resources/machineset.py

+
+    def __enter__(self):
+        super().__enter__()
+        if self.wait_ready_state and not self.wait(timeout=self.replicas * TIMEOUT):


This is not part of the creation, if you need to wait for some state, do it in a function.
enter is called when the user do with ....

ack, yes i figured it might be nice to give the user an option to wait for the machine-set state while using the context manager, but it might be better to split that

myakove · 2021-08-17T08:35:42Z

ocp_resources/machineset.py

+            bool: True if updating the machine-set was successful, False otherwise.
+        """
+        LOGGER.info(f"Update machine-set {self.name} to {patches}")
+        ResourceEditor(patches={self: patches}).update()


you don't need to call ResourceEditor from inside a resource
check how we do it in Deployment.scale_replicas

myakove · 2021-08-17T08:38:14Z

ocp_resources/machineset.py

+            "cluster-api-machineset",
+        )
+
+        res[_metadata].setdefault(_labels, {}).update(


Discard my previous comments please, make is simple
no need to use setdefault(), just build you dict as needed.
we can assume that anyone that cal to_dict() create new resource.

myakove · 2021-08-18T08:53:00Z

ocp_resources/machineset.py

+                if ready_replicas and ready_replicas == self.desired_replicas:
+                    return True
+        except TimeoutExpiredError:
+            LOGGER.error(


please fit all errors in one LOGGER.error

myakove · 2021-08-18T08:56:51Z

ocp_resources/machineset.py

+    def provider_spec_value(self):
+        return self.instance.spec.template.spec.providerSpec.value
+
+    def wait(self, timeout=TIMEOUT, sleep=1):


wait please rename, this function wait for replicas

myakove · 2021-08-18T08:57:18Z

ocp_resources/machineset.py

+            )
+            return False
+
+    def scale(self, replicas, wait_timeout=TIMEOUT, sleep=1, wait=True):


scale ditto rename to scale_replicas

rnetser · 2021-08-19T14:58:17Z

ocp_resources/machineset.py

@@ -0,0 +1,189 @@
+import logging


Please rename to machine_set.py

rnetser · 2021-08-19T15:02:16Z

ocp_resources/machineset.py

+            wait (bool): True if waiting for machine-set to reach into 'ready' state, False otherwise.
+
+        Returns:
+            bool: True if scaling the machine set was successful, False otherwise.


Returns True also if wait=False (and not necessarily if scaling succeeded)

I don't think its necessary to add it to the docstring.

basically if the update function didn't raise an exception, then that means the update was successful.

if wait=False, wait_for_replicas is not called.
A user should know from the docstring what is the expected behavior; for example:
bool: True if scaling the machine set was successful or wait=False, False otherwise.

ocp_resources/machine_set.py

This patch adds the abilty to create the 'machineset' resource.

sonarcloud · 2021-08-22T11:21:00Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

myakove · 2021-08-23T11:03:31Z

/approve

GuyAfik · 2021-08-23T13:02:15Z

/verified

rnetser · 2021-08-24T10:00:51Z

/approve

cnv-qe-bot requested review from myakove and rnetser August 9, 2021 13:45

cnv-qe-bot added the size/M label Aug 9, 2021

myakove requested changes Aug 9, 2021

View reviewed changes

cnv-qe-bot requested a review from myakove August 9, 2021 21:23

cnv-qe-bot added the size/L label Aug 9, 2021

GuyAfik force-pushed the add_machineset_resource branch from 71be86a to 9238a17 Compare August 9, 2021 21:40

myakove removed size/M size/L labels Aug 10, 2021

myakove requested changes Aug 10, 2021

View reviewed changes

GuyAfik requested a review from myakove August 10, 2021 12:39

GuyAfik force-pushed the add_machineset_resource branch from 9238a17 to 8d0f527 Compare August 11, 2021 08:22

cnv-qe-bot added the size/L label Aug 11, 2021

myakove requested changes Aug 11, 2021

View reviewed changes

myakove reviewed Aug 11, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from 8d0f527 to bf2cb4f Compare August 11, 2021 10:11

cnv-qe-bot requested a review from myakove August 11, 2021 10:12

cnv-qe-bot added size/L and removed size/L labels Aug 11, 2021

rnetser reviewed Aug 12, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from bf2cb4f to 7a49a64 Compare August 12, 2021 19:24

cnv-qe-bot requested a review from rnetser August 12, 2021 19:25

myakove requested changes Aug 15, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from 7a49a64 to 6349f5e Compare August 16, 2021 18:30

cnv-qe-bot requested a review from myakove August 16, 2021 18:31

GuyAfik force-pushed the add_machineset_resource branch from 6349f5e to 4e8d29b Compare August 16, 2021 20:30

myakove requested changes Aug 17, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from 4e8d29b to 2a3fb47 Compare August 17, 2021 12:43

cnv-qe-bot requested a review from myakove August 17, 2021 12:44

myakove requested changes Aug 18, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from 2a3fb47 to 6ae5abf Compare August 18, 2021 11:48

cnv-qe-bot requested a review from myakove August 18, 2021 11:49

rnetser reviewed Aug 19, 2021

View reviewed changes

GuyAfik force-pushed the add_machineset_resource branch from 6ae5abf to b4a46ce Compare August 19, 2021 18:00

cnv-qe-bot requested a review from rnetser August 19, 2021 18:00

GuyAfik force-pushed the add_machineset_resource branch from b4a46ce to f534c78 Compare August 22, 2021 08:12

rnetser requested changes Aug 22, 2021

View reviewed changes

ocp_resources/machine_set.py Outdated Show resolved Hide resolved

add machineset resource implementation

34fc622

This patch adds the abilty to create the 'machineset' resource.

GuyAfik force-pushed the add_machineset_resource branch from f534c78 to 34fc622 Compare August 22, 2021 11:18

cnv-qe-bot requested a review from rnetser August 22, 2021 11:19

cnv-qe-bot added the Approve label Aug 23, 2021

cnv-qe-bot added the Verified label Aug 23, 2021

myakove merged commit f2a2178 into RedHatQE:master Aug 24, 2021

GuyAfik deleted the add_machineset_resource branch August 24, 2021 18:41

		@@ -0,0 +1,91 @@
		from ocp_resources.machine import NamespacedResource

add machineset resource implementation #97

add machineset resource implementation #97

Conversation

GuyAfik commented Aug 9, 2021

Short description:

More details:

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewer:

Bug:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuyAfik Aug 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

myakove left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuyAfik Aug 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 22, 2021

myakove commented Aug 23, 2021

GuyAfik commented Aug 23, 2021

rnetser commented Aug 24, 2021

GuyAfik Aug 10, 2021 •

edited

Loading

GuyAfik Aug 17, 2021 •

edited

Loading