Refactor labels and make docker label auto-generated instead of default. #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In order to allow re-use across different platforms, the docker label shouldn't be the default. Since there is no default, let's leave it off. This means we need to handle its absence in the recipe. We also add the docker label (if it is not already present) automatically for all hosts since all Linux hosts are docker agents currently.
Also fixes an indention inconsistency.
nuclearsandwich
commented
Mar 17, 2023
Comment on lines
+49
to
+53
| node_labels = if node['osrfbuild']['agent']['labels'] | ||
| node['osrfbuild']['agent']['labels'].dup | ||
| else | ||
| Array.new | ||
| end |
There was a problem hiding this comment.
There's a way to do this in one line with Ruby's safe navigation operator but I hesitate to do so given that it's not a very common or at-a-glance readable expression. Open to other preferences though.
Suggested change
| node_labels = if node['osrfbuild']['agent']['labels'] | |
| node['osrfbuild']['agent']['labels'].dup | |
| else | |
| Array.new | |
| end | |
| node_labels = node['osrfbuild']['agent']['labels']&.dup || Array.new |
There was a problem hiding this comment.
new syntax is really great but I have no previous idea about the safe navigation operator. I'm inclined to leave as it is in the PR.
j-rivero
approved these changes
Apr 12, 2023
Comment on lines
+49
to
+53
| node_labels = if node['osrfbuild']['agent']['labels'] | ||
| node['osrfbuild']['agent']['labels'].dup | ||
| else | ||
| Array.new | ||
| end |
There was a problem hiding this comment.
new syntax is really great but I have no previous idea about the safe navigation operator. I'm inclined to leave as it is in the PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change is prompted by the addition of recipes for macOS agents coming in a further PR.
Due to the way chef attributes are interleaved, the default
dockerlabel will be applied to any node which does not use anoverridelevel attribute to remove it (see attribute precedence docs).Instead, I've made the docker label unconditionally applied when auto-generated labels are enabled since the default recipe is currently for Linux agents and all current linux agents are docker agents. Changes to that assumption in the future would require additional significant changes to the recipes so I'm not too worried about that.
Since the docker label is being applied by default where applicable, I removed it from the default attributes and updated the recipe to handle a lack of default labels.
I also set it up so that labels which are defined in node attributes won't get added if they're already listed. Ruby has a Set class in the standard library which we could use but I don't think there's a justification over these little logic snippets.