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.

Sign up for GitHub

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

fix (jkube-kit/enricher) : WellKnownLabelEnricher also considers labels added via resource configuration #2587

Merged
merged 2 commits into from
Feb 5, 2024
Merged

fix (jkube-kit/enricher) : WellKnownLabelEnricher also considers labels added via resource configuration #2587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e214f2
fix (jkube-kit/enricher) : WellKnownLabelEnricher also considers labe…
rohanKanojia Jan 25, 2024
420c2ec
review: Well Known Label Enricher
manusa Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions gradle-plugin/it/src/it/well-known-labels/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,32 @@ repositories {
mavenCentral()
}

def allProperties = new Properties();
allProperties.put("team","via-resource-groovy-dsl-labels-all")
allProperties.put("language", "via-resource-groovy-dsl-labels-all")
allProperties.put("provider", "via-resource-groovy-dsl-labels-all")
allProperties.put("app", "via-resource-groovy-dsl-labels-all")
allProperties.put("version", "via-resource-groovy-dsl-labels-all")
allProperties.put("group", "via-resource-groovy-dsl-labels-all")
allProperties.put("app.kubernetes.io/name", "via-resource-groovy-dsl-labels-all")
allProperties.put("app.kubernetes.io/version", "via-resource-groovy-dsl-labels-all")
allProperties.put("app.kubernetes.io/component", "via-resource-groovy-dsl-labels-all")
allProperties.put("app.kubernetes.io/managed-by", "via-resource-groovy-dsl-labels-all")
allProperties.put("app.kubernetes.io/part-of", "via-resource-groovy-dsl-labels-all")

def serviceProperties = new Properties();
serviceProperties.put("team", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("language", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("provider", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("version", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("group", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app.kubernetes.io/name", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app.kubernetes.io/version", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app.kubernetes.io/component", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app.kubernetes.io/managed-by", "via-resource-groovy-dsl-labels-service")
serviceProperties.put("app.kubernetes.io/part-of", "via-resource-groovy-dsl-labels-service")

def extensionConfig = {
offline = true
images {
Expand All @@ -36,6 +62,14 @@ def extensionConfig = {
}
}
}
if (project.hasProperty('labelsViaResourceConfig')) {
resources {
labels {
all = allProperties
service = serviceProperties
}
}
}
}

kubernetes(extensionConfig)
Expand Down
103 changes: 103 additions & 0 deletions gradle-plugin/it/src/it/well-known-labels/expected/labelsViaResourceConfig/kubernetes.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
apiVersion: v1
kind: List
items:
- apiVersion: v1
kind: Service
metadata:
annotations:
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-service
app.kubernetes.io/component: via-resource-groovy-dsl-labels-service
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-service
app.kubernetes.io/name: via-resource-groovy-dsl-labels-service
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-service
app.kubernetes.io/version: via-resource-groovy-dsl-labels-service
group: via-resource-groovy-dsl-labels-service
provider: via-resource-groovy-dsl-labels-service
version: via-resource-groovy-dsl-labels-service
name: well-known-labels
spec:
ports:
- name: http
port: 8080
protocol: TCP
targetPort: 8080
selector:
app: via-resource-groovy-dsl-labels-service
app.kubernetes.io/component: via-resource-groovy-dsl-labels-service
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-service
app.kubernetes.io/name: via-resource-groovy-dsl-labels-service
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-service
group: via-resource-groovy-dsl-labels-service
provider: via-resource-groovy-dsl-labels-service
- apiVersion: apps/v1
kind: Deployment
metadata:
annotations:
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
app.kubernetes.io/version: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
version: via-resource-groovy-dsl-labels-all
name: well-known-labels
spec:
replicas: 1
revisionHistoryLimit: 2
selector:
matchLabels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
template:
metadata:
annotations:
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
app.kubernetes.io/version: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
version: via-resource-groovy-dsl-labels-all
name: well-known-labels
spec:
containers:
- env:
- name: KUBERNETES_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: HOSTNAME
valueFrom:
fieldRef:
fieldPath: metadata.name
image: repository/well-known-labels:latest
imagePullPolicy: IfNotPresent
name: repository-well-known-labels
ports:
- containerPort: 8080
name: http
protocol: TCP
securityContext:
privileged: false
144 changes: 144 additions & 0 deletions gradle-plugin/it/src/it/well-known-labels/expected/labelsViaResourceConfig/openshift.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
apiVersion: v1
kind: List
items:
- apiVersion: v1
kind: Service
metadata:
annotations:
app.openshift.io/vcs-ref: "@ignore@"
app.openshift.io/vcs-uri: "@ignore@"
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-service
app.kubernetes.io/component: via-resource-groovy-dsl-labels-service
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-service
app.kubernetes.io/name: via-resource-groovy-dsl-labels-service
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-service
app.kubernetes.io/version: via-resource-groovy-dsl-labels-service
group: via-resource-groovy-dsl-labels-service
provider: via-resource-groovy-dsl-labels-service
version: via-resource-groovy-dsl-labels-service
name: well-known-labels
spec:
ports:
- name: http
port: 8080
protocol: TCP
targetPort: 8080
selector:
app: via-resource-groovy-dsl-labels-service
app.kubernetes.io/component: via-resource-groovy-dsl-labels-service
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-service
app.kubernetes.io/name: via-resource-groovy-dsl-labels-service
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-service
group: via-resource-groovy-dsl-labels-service
provider: via-resource-groovy-dsl-labels-service
- apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
annotations:
app.openshift.io/vcs-ref: "@ignore@"
app.openshift.io/vcs-uri: "@ignore@"
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
app.kubernetes.io/version: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
version: via-resource-groovy-dsl-labels-all
name: well-known-labels
spec:
replicas: 1
revisionHistoryLimit: 2
selector:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
strategy:
rollingParams:
timeoutSeconds: 3600
type: Rolling
template:
metadata:
annotations:
app.openshift.io/vcs-ref: "@ignore@"
app.openshift.io/vcs-uri: "@ignore@"
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
app.kubernetes.io/version: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
version: via-resource-groovy-dsl-labels-all
name: well-known-labels
spec:
containers:
- env:
- name: KUBERNETES_NAMESPACE
valueFrom:
fieldRef:
fieldPath: metadata.namespace
image: repository/well-known-labels:latest
imagePullPolicy: IfNotPresent
name: repository-well-known-labels
ports:
- containerPort: 8080
name: http
protocol: TCP
securityContext:
privileged: false
triggers:
- type: ConfigChange
- imageChangeParams:
automatic: true
containerNames:
- repository-well-known-labels
from:
kind: ImageStreamTag
name: well-known-labels:latest
type: ImageChange
- apiVersion: route.openshift.io/v1
kind: Route
metadata:
annotations:
app.openshift.io/vcs-ref: "@ignore@"
app.openshift.io/vcs-uri: "@ignore@"
jkube.eclipse.org/git-branch: "@ignore@"
jkube.eclipse.org/git-commit: "@ignore@"
jkube.eclipse.org/git-url: "@ignore@"
labels:
app: via-resource-groovy-dsl-labels-all
app.kubernetes.io/component: via-resource-groovy-dsl-labels-all
app.kubernetes.io/managed-by: via-resource-groovy-dsl-labels-all
app.kubernetes.io/name: via-resource-groovy-dsl-labels-all
app.kubernetes.io/part-of: via-resource-groovy-dsl-labels-all
app.kubernetes.io/version: via-resource-groovy-dsl-labels-all
group: via-resource-groovy-dsl-labels-all
provider: via-resource-groovy-dsl-labels-all
version: via-resource-groovy-dsl-labels-all
name: well-known-labels
spec:
port:
targetPort: 8080
to:
kind: Service
name: well-known-labels
3 changes: 2 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/WellKnownLabelsIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ static Stream<Arguments> data() {
"-Pjkube.enricher.jkube-well-known-labels.component=custom-component",
"-Pjkube.enricher.jkube-well-known-labels.partOf=custom-part-of",
"-Pjkube.enricher.jkube-well-known-labels.managedBy=custom-managed-by",
})
}),
arguments("labelsViaResourceConfig", new String[] {"-PlabelsViaResourceConfig=true"})
);
}

Expand Down
42 changes: 32 additions & 10 deletions jkube-kit/common/src/main/java/org/eclipse/jkube/kit/common/util/MapUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;
import java.util.function.BiFunction;

public class MapUtil {
Expand All @@ -42,28 +43,49 @@ public static void mergeIfAbsent(Map<String, String> map, Map<String, String> to
}

/**
* Returns a new map with all the entries of map1 and any from map2 which don't override map1.
* Returns a new map with all the entries of first map with rest map entries which don't override map1.
*
* Can handle either maps being null. Always returns a new mutable map
* Can handle either maps being null. Always returns a new mutable map.
*
* @param map1 first hash map
* @param map2 second hash map
* <b>Note:</b> Be careful about the ordering of maps passed here. First map passed in the var args
* would always be given precedence over other maps in case there are colliding entries with same key values.
*
* @param maps var arg for maps
* @param <K> first type
* @param <V> second type
Comment on lines 54 to 55
Copy link
Member

Choose a reason for hiding this comment

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

Should be changed.

We might also want to comment on the precedence of the maps

Copy link
Member Author

Choose a reason for hiding this comment

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

Are you referring to @param entries for types?

Copy link
Member

Choose a reason for hiding this comment

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

yes

* @return merged hash map
*/
public static <K,V> Map<K,V> mergeMaps(Map<K, V> map1, Map<K, V> map2) {
@SafeVarargs
public static <K,V> Map<K,V> mergeMaps(Map<K, V>... maps) {
Map<K, V> answer = new HashMap<>();
if (map2 != null) {
answer.putAll(map2);
}
if (map1 != null) {
answer.putAll(map1);
for (int i = maps.length-1; i >= 0; i--) {
if (maps[i] != null) {
answer.putAll(maps[i]);
}
}
return answer;

}

/**
* Returns a new map with all the entries the provided properties merged.
*
* The first arguments take precedence over the later ones.
* i.e. properties defined in the last argument will not override properties defined in the first argument.
*
* @param properties var arg for properties
* @return merged hash map
*/
public static Map<String, String> mergeMaps(Properties... properties) {
Map<String, String> answer = new HashMap<>();
for (int i = properties.length-1; i >= 0; i--) {
if (properties[i] != null) {
answer.putAll(PropertiesUtil.toMap(properties[i]));
}
}
return answer;
}

/**
* Copies all the elements i.e., the mappings, from toPut map into ret, if toPut isn't null.
* @param ret target hash map
Expand Down
Loading