Issue #1794 - Fix for tags not being honored in karate-gatling

[packleader]

Description

• Relevant Issues : Tags Do Not Work Correctly in karate-gatling:1.1.0 And Higher #1794
• Relevant PRs : None
• Type of change :
  • New feature
  • Bug fix for existing feature
  • Code quality improvement
  • Addition or Improvement of tests
  • Addition or Improvement of documentation

KarateFeatureAction makes a copy of protocol.runner and then sets the tags on that copy. In order to honor the tags, we need to pass the copy to Runner.callAsync rather than the original protocol.runner.

I have validated that the fix works by following the steps I documented in #1794.

[packleader]

This is a critical bugfix for my team. We need to be able to set multiple tags using karateFeature("path", "@tagOne", "@tagTwo"), so #1794 is preventing us from upgrading from v0.9.6.

If possible, we'd like to ask that this fix be included in v1.1.1 or v1.2.0. Thank you.

[ptrthomas]

@packleader PRs have to be against develop so I've switched it.

I'd need more investigation. the protocol.runner part was introduced specifically to solve for "unifying" the Runner, refer #1622

not sure if protocol.runner.tags() gets you what you want or it becomes "global, but I think we tried to make it different for each karateFeature()

this may not be relevant since you want multiple tags, but karateFeature('some.feature@foo') should work for a single tag

[packleader]

Thanks for fixing the target branch. I always forget that part.

I agree that karateFeature('some.feature@foo') will work. However, we have several existing test cases that use karateFeature('some.feature', '@foo', '@bar'). They broke when we upgraded from 0.9.6 to 1.1.0.

I'll admit that I don't fully understand how the Protocol and Runner work. But it seems odd that we create val runner = protocol.runner.copy() but then don't really use it. We call a few setters on it, but that's all. It seems to me that we should either do:

    val runner = protocol.runner.copy()
    runner.callSingleCache(protocol.callSingleCache)
    runner.callOnceCache(protocol.callOnceCache)
    runner.tags(tags.asJava)

    Runner.callAsync(runner, name, callArg, perfHook)

or:

    protocol.runner.callSingleCache(protocol.callSingleCache)
    protocol.runner.callOnceCache(protocol.callOnceCache)
    protocol.runner.tags(tags.asJava)

    Runner.callAsync(protocol.runner, name, callArg, perfHook)

[ptrthomas]

@packleader thank you ! that helped, and I must have missed switching to the "cloned" runner.