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

feat(trait): add InfluencesBuild() func #4512

Merged
merged 1 commit into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/architecture/traits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ type Trait interface {
Configure(environment *Environment) (bool, error)
Apply(environment *Environment) error
InfluencesKit() bool
InfluencesBuild(this, prev map[string]interface{}) bool
IsPlatformTrait() bool
RequiresIntegrationPlatform() bool
IsAllowedInProfile(v1.TraitProfile) bool
Expand All @@ -58,4 +59,6 @@ The `Order()` method helps in resolving the order of execution of different trai

The `InfluencesKit()`, `IsPlatformTrait()` and `RequiresIntegrationPlatform()` methods are easy to understand. They are used to determine if a trait has to influence an `IntegrationKit` build/initialization, if it's a platform trait (ie, needed by the platform itself) or are requiring the presence of an `IntegrationPlatform`.

The presence of `InfluencesBuild()` will let specify the level of granularity of a trait down to its properties for a rebuild. So, if you need, you can compare the traits properties coming from the `prev` (previous) Integration to decide if it is worth to rebuild an Integration or the trait can reuse the one already provided in `this` version.

Finally, through the `IsAllowedInProfile()` method we can override the default behavior (allow the trait for any profile). We must specify the profile we expect for this trait to be executed properly.
61 changes: 61 additions & 0 deletions e2e/common/traits/camel_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
//go:build integration
// +build integration

// To enable compilation of this file in Goland, go to "Settings -> Go -> Vendoring & Build Tags -> Custom Tags" and add "integration"

/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package traits

import (
"testing"

. "github.com/onsi/gomega"

corev1 "k8s.io/api/core/v1"

. "github.com/apache/camel-k/v2/e2e/support"
v1 "github.com/apache/camel-k/v2/pkg/apis/camel/v1"
)

func TestCamelTrait(t *testing.T) {
RegisterTestingT(t)

t.Run("properties changes should not rebuild", func(t *testing.T) {
name := "java"
Expect(KamelRunWithID(operatorID, ns, "files/Java.java",
"--name", name,
).Execute()).To(Succeed())
Eventually(IntegrationPodPhase(ns, name), TestTimeoutLong).Should(Equal(corev1.PodRunning))
Eventually(IntegrationConditionStatus(ns, name, v1.IntegrationConditionReady), TestTimeoutShort).Should(Equal(corev1.ConditionTrue))
Eventually(IntegrationLogs(ns, name), TestTimeoutShort).Should(ContainSubstring("Magicstring!"))
integrationKit := IntegrationKit(ns, name)()

Expect(KamelRunWithID(operatorID, ns, "files/Java.java",
"--name", name,
"-p", "a=1",
).Execute()).To(Succeed())
Eventually(IntegrationPodPhase(ns, name), TestTimeoutShort).Should(Equal(corev1.PodRunning))
Eventually(IntegrationConditionStatus(ns, name, v1.IntegrationConditionReady), TestTimeoutShort).Should(Equal(corev1.ConditionTrue))
Eventually(IntegrationLogs(ns, name), TestTimeoutShort).Should(ContainSubstring("Magicstring!"))
Eventually(IntegrationKit(ns, name)).Should(Equal(integrationKit))
})

// Clean-up
Expect(Kamel("delete", "--all", "-n", ns).Execute()).To(Succeed())
}
25 changes: 12 additions & 13 deletions pkg/controller/integration/kits.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,7 @@ func hasMatchingTraits(traitMap trait.Options, kitTraitMap trait.Options) (bool,
catalog := trait.NewCatalog(nil)

for _, t := range catalog.AllTraits() {
if t == nil || !t.InfluencesKit() {
// We don't store the trait configuration if the trait cannot influence the kit behavior
if t == nil {
continue
}

Expand All @@ -211,17 +210,17 @@ func hasMatchingTraits(traitMap trait.Options, kitTraitMap trait.Options) (bool,
if !ok1 && !ok2 {
continue
}
if !ok1 || !ok2 {
return false, nil
}
if ct, ok := t.(trait.ComparableTrait); ok {
// if it's match trait use its matches method to determine the match
if match, err := matchesComparableTrait(ct, it, kt); !match || err != nil {
return false, err
}
} else {
if !matchesTrait(it, kt) {
return false, nil

if t.InfluencesKit() && t.InfluencesBuild(it, kt) {
if ct, ok := t.(trait.ComparableTrait); ok {
// if it's match trait use its matches method to determine the match
if match, err := matchesComparableTrait(ct, it, kt); !match || err != nil {
return false, err
}
} else {
if !matchesTrait(it, kt) {
return false, nil
}
}
}
}
Expand Down
17 changes: 17 additions & 0 deletions pkg/resources/resources.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions pkg/trait/builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ func (t *builderTrait) InfluencesKit() bool {
return true
}

// InfluencesBuild overrides base class method.
func (t *builderTrait) InfluencesBuild(this, prev map[string]interface{}) bool {
return true
}

func (t *builderTrait) Configure(e *Environment) (bool, error) {
if e.IntegrationKit == nil || !pointer.BoolDeref(t.Enabled, true) {
return false, nil
Expand Down
5 changes: 5 additions & 0 deletions pkg/trait/camel.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ func (t *camelTrait) InfluencesKit() bool {
return true
}

// InfluencesBuild only when the runtime has changed.
func (t *camelTrait) InfluencesBuild(this, prev map[string]interface{}) bool {
return this["runtimeVersion"] != prev["runtimeVersion"]
}

func (t *camelTrait) Configure(e *Environment) (bool, error) {
if !pointer.BoolDeref(t.Enabled, true) {
return false, errors.New("trait camel cannot be disabled")
Expand Down
5 changes: 5 additions & 0 deletions pkg/trait/quarkus.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ func (t *quarkusTrait) InfluencesKit() bool {
return true
}

// InfluencesBuild overrides base class method.
func (t *quarkusTrait) InfluencesBuild(this, prev map[string]interface{}) bool {
return true
}

var _ ComparableTrait = &quarkusTrait{}

func (t *quarkusTrait) Matches(trait Trait) bool {
Expand Down
5 changes: 5 additions & 0 deletions pkg/trait/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ func (t *registryTrait) InfluencesKit() bool {
return true
}

// InfluencesBuild overrides base class method.
func (t *registryTrait) InfluencesBuild(this, prev map[string]interface{}) bool {
return true
}

func (t *registryTrait) Configure(e *Environment) (bool, error) {
// disabled by default
if e.IntegrationKit == nil || !pointer.BoolDeref(t.Enabled, false) {
Expand Down
11 changes: 11 additions & 0 deletions pkg/trait/trait_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ type Trait interface {
// InfluencesKit determines if the trait has any influence on Integration Kits
InfluencesKit() bool

// InfluencesBuild defines a low level of granularity for those traits which influences the build.
// The trait can specify if any particular trait configuration influences a build or not.
// Note: You must override this method if you override `InfluencesKit()`
InfluencesBuild(this, prev map[string]interface{}) bool

// IsPlatformTrait marks all fundamental traits that allow the platform to work
IsPlatformTrait() bool

Expand Down Expand Up @@ -135,6 +140,12 @@ func (trait *BaseTrait) InfluencesKit() bool {
return false
}

// InfluencesBuild defines a low level of granularity for those traits which influences the build.
// The trait can specify if any particular trait configuration influences a build or not.
func (trait *BaseTrait) InfluencesBuild(this, prev map[string]interface{}) bool {
return false
}

// IsPlatformTrait marks all fundamental traits that allow the platform to work.
func (trait *BaseTrait) IsPlatformTrait() bool {
return false
Expand Down