feat: junit report directory by IliyanKordev · Pull Request #413 · eclipse-kiso-testing/kiso-testing

IliyanKordev · 2023-11-14T09:30:47Z

No description provided.

codecov · 2023-11-15T10:10:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (61e219e) 98.11% compared to head (1c3342e) 98.11%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #413   +/-   ##
=======================================
  Coverage   98.11%   98.11%           
=======================================
  Files          80       80           
  Lines        6471     6487   +16     
=======================================
+ Hits         6349     6365   +16     
  Misses        122      122

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sebastianpfischer

The coverage report is not generated correctly anymore

stefandtotev · 2023-11-15T13:30:44Z

+        # filter flags
+        flags = [
+            o
+            for o in self.params


Please change the naming from o to param. Same for some of the other loops below, it's best to give descriptive names instead of single character names

Ok, i will fix names

Pog3k · 2023-11-15T13:41:54Z

    step_report: Optional[Path] = None,
    pattern_inject: Optional[str] = None,
    failfast: bool = False,
+    junit_path: str = "reports",


update docstring for junit_path

ok, i will fix it

Pog3k · 2023-11-15T14:01:10Z

-            reports_path = project_folder / "reports"
-            junit_report_path = reports_path / junit_report_name
-            reports_path.mkdir(exist_ok=True)
+            report_path = Path(junit_path)


Somehow you broke the old behaviour.

If I run
pykiso -c .\examples\dummy.yaml --junit
the report is now created at the location where pykiso has been started. Before those files where in the
"reports" folder. I would expect that same behaviour if user dont specify any path...

Something like this
pykiso -c .\examples\dummy.yaml --junit customname.xml doesnt work at all.

pykiso --help also doesnt show the optional flag.

ok, i fixed it

Pog3k · 2023-11-15T15:01:53Z

-            reports_path = project_folder / "reports"
-            junit_report_path = reports_path / junit_report_name
-            reports_path.mkdir(exist_ok=True)
+            report_path = junit_path


do we need the renaming ?
Just proceed with junit_path instead of report_path

ok, i will rename it

Pog3k · 2023-11-15T15:02:46Z

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>


Remove this folder and all its contents

ok, i will remove it

sebastianpfischer · 2023-11-16T06:43:29Z

@Pog3k, if you merge it before I do, please squash the PR before

sebastianpfischer · 2023-11-16T06:48:09Z

Sorry, I start reading the PR, I do not understand what you try to do. Could you please explain it to me?

sebastianpfischer · 2023-11-16T06:50:14Z

-            junit_report_path = reports_path / junit_report_name
-            reports_path.mkdir(exist_ok=True)
+            report_path = junit_path
+            full_report_path = Path.cwd() / report_path


That would not work if I drop the location, I will get a absolute path instead

what do you mean ?
I mean I looks weird but if report_path is an abspath Path.cwd() gets ignored...
tested on windows and linux

Really, cool, still please comment on top, because yes, it looks really weird ^^

Code documentation, like mention above, still missing

sebclrsn · 2023-11-20T14:13:07Z

+            and flag.is_flag
+            and not isinstance(flag.flag_value, bool)
+        ]
+        junit_prefixes = {


Could this somehow be made generic?
It feels weird to have a class named CommandWithOptionalFlagValues (very generic name) that only handles one specific flag name --junit

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

sebclrsn · 2023-11-24T14:24:39Z

+class CommandWithOptionalFlagValues(click.Command):
+    def parse_args(self, ctx, args):
+        """Translate any flag `--junit=value` as flag `--junit` with changed flag_value=value"""
+        # filter flags
+        flags = [
+            flag
+            for flag in self.params
+            if isinstance(flag, click.Option)
+            and flag.is_flag
+            and not isinstance(flag.flag_value, bool)
+        ]
+        junit_prefixes = {
+            flag_str: flag
+            for flag in flags
+            for flag_str in flag.opts
+            if flag_str.startswith("--junit")
+        }
+
+        for index, arg in enumerate(args):
+            arg = arg.split("=")
+            if len(arg) < 2:
+                continue
+            junit_prefixes[arg[0]].flag_value = arg[1]
+            args[index] = arg[0]
+        result_args = super(CommandWithOptionalFlagValues, self).parse_args(ctx, args)
+        return result_args


To make this generic:

Suggested change

class CommandWithOptionalFlagValues(click.Command):

def parse_args(self, ctx, args):

"""Translate any flag `--junit=value` as flag `--junit` with changed flag_value=value"""

# filter flags

flags = [

flag

for flag in self.params

if isinstance(flag, click.Option)

and flag.is_flag

and not isinstance(flag.flag_value, bool)

]

junit_prefixes = {

flag_str: flag

for flag in flags

for flag_str in flag.opts

if flag_str.startswith("--junit")

}

for index, arg in enumerate(args):

arg = arg.split("=")

if len(arg) < 2:

continue

junit_prefixes[arg[0]].flag_value = arg[1]

args[index] = arg[0]

result_args = super(CommandWithOptionalFlagValues, self).parse_args(ctx, args)

return result_args

class CommandWithOptionalFlagValues(click.Command):

def parse_args(self, ctx, args):

"""Translate any flag `--junit=value` as flag `--junit` with changed flag_value=value"""

# filter flags

flags = [

flag

for flag in self.params

if isinstance(flag, click.Option)

and flag.is_flag

and not isinstance(flag.flag_value, bool)

]

for arg_index, arg in enumerate(args):

arg = arg.split("=")

if len(arg) != 2:

continue

arg_name, arg_value = arg

for flag in flags:

if arg_name in flag.opts:

flag.flag_value = arg_value

args[arg_index] = arg_name

break

result_args = super(CommandWithOptionalFlagValues, self).parse_args(ctx, args)

return result_args

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

sebclrsn

Just add an entry in the what's new that explains these changes and we're good to go, e.g.:

The ``--junit`` option can now be provided with a value, indicating the folder or file where the report should be written, e.g. ``pykiso -c my_config.yaml --junit=./reports/my_config.xml``.
This is now the preferred way of setting the JUnit reports path, and providing only ``--junit`` will progressively be deprecated in the future.

sebastianpfischer · 2023-11-28T15:47:29Z

    return paths


+class CommandWithOptionalFlagValues(click.Command):


Documentation, types missing.
Also documentation of the code too.

sebastianpfischer · 2023-11-28T15:49:03Z

-            junit_report_path = reports_path / junit_report_name
-            reports_path.mkdir(exist_ok=True)
+            report_path = junit_path
+            full_report_path = Path.cwd() / report_path


Code documentation, like mention above, still missing

IliyanKordev · 2023-11-29T09:44:26Z

Sorry, I start reading the PR, I do not understand what you try to do. Could you please explain it to me?

I think the confusing part is that --junit was just a flag in the past. To dont introduce a breaking change or an addtional flag the call now looks like this --junit=my.xml So Both calls are now valid pykiso -c .\examples\dummy.yaml --junit=my.xml pykiso -c .\examples\dummy.yaml --junit
Or what is still unclear ?

This is actually cool but why not simply a -o like all the other tools do?

Because, it is easier and more clear for the teams, without adding new arguments of pykiso

sebclrsn

Just apply the code comments for understanding and we're good to go

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

IliyanKordev and others added 5 commits November 14, 2023 10:05

Add new argument for junit path

19dd236

Merge branch 'eclipse:master' into feature/-junit-report-directory

7c1ecc5

Fix arguments in main

aff244a

Fix file path creation

cd3fb3d

Fix default parameter

406a4f9

sebastianpfischer requested changes Nov 15, 2023

View reviewed changes

IliyanKordev added 2 commits November 15, 2023 13:35

Add unit tests and add comments

7cf6e56

Fix test with dir

0b23013

stefandtotev reviewed Nov 15, 2023

View reviewed changes

Pog3k reviewed Nov 15, 2023

View reviewed changes

Remove report name

60ffe90

Pog3k reviewed Nov 15, 2023

View reviewed changes

IliyanKordev added 7 commits November 15, 2023 16:01

Fix Path problem

d69ffe0

fix default path

5d54337

Fix dir creation

c6aee8c

Fix folder creation

0d7c67f

remove breakpoint

cfbbcfd

Fix aux names

4e24ca1

Fix tests

330bf61

Pog3k reviewed Nov 15, 2023

View reviewed changes

IliyanKordev added 5 commits November 15, 2023 17:06

comment test

1f5c38b

Commend second test with junit

12c4262

Fix test parametrization

feda713

comment tests for junit

9f260a2

combine tests

098feee

sebastianpfischer reviewed Nov 16, 2023

View reviewed changes

sebclrsn reviewed Nov 20, 2023

View reviewed changes

Comment thread src/pykiso/cli.py Outdated

sebclrsn reviewed Nov 20, 2023

View reviewed changes

Comment thread src/pykiso/cli.py Outdated

IliyanKordev and others added 5 commits November 21, 2023 09:45

Update src/pykiso/cli.py

2bf1490

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Update src/pykiso/cli.py

35aeb42

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Fix ident

b3b7a81

Remove one test and add parametrization

1c1a15a

Rename variable

4bbfb7b

sebclrsn reviewed Nov 24, 2023

View reviewed changes

Comment thread src/pykiso/cli.py Outdated

sebclrsn reviewed Nov 24, 2023

View reviewed changes

Comment thread src/pykiso/cli.py Outdated

sebclrsn reviewed Nov 24, 2023

View reviewed changes

IliyanKordev and others added 5 commits November 27, 2023 10:27

Update src/pykiso/cli.py

ef21ef9

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Update src/pykiso/cli.py

1bab118

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Apply sugestions

6da4ae3

Merge branch 'master' into feature/junit_report_directory

d940d8c

Remove used import

fcd37d5

sebclrsn reviewed Nov 27, 2023

View reviewed changes

sebclrsn requested a review from sebastianpfischer November 28, 2023 15:25

sebastianpfischer requested changes Nov 28, 2023

View reviewed changes

sebclrsn reviewed Nov 30, 2023

View reviewed changes

Comment thread src/pykiso/cli.py Outdated

Comment thread src/pykiso/cli.py

Comment thread src/pykiso/cli.py

Comment thread src/pykiso/cli.py

IliyanKordev and others added 4 commits November 30, 2023 13:53

Update src/pykiso/cli.py

3671a1c

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Update src/pykiso/cli.py

d592b0c

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Update src/pykiso/cli.py

6c988c5

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

Update src/pykiso/cli.py

7acc538

Co-authored-by: Sebastian Clerson <58192998+sebclrsn@users.noreply.github.com>

sebclrsn requested review from sebastianpfischer and sebclrsn November 30, 2023 12:25

sebclrsn approved these changes Nov 30, 2023

View reviewed changes

Reformat the code

1c3342e

Pog3k merged commit ef87422 into eclipse-kiso-testing:master Dec 1, 2023

		return paths


		class CommandWithOptionalFlagValues(click.Command):

Conversation

IliyanKordev commented Nov 14, 2023

Uh oh!

codecov Bot commented Nov 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sebastianpfischer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IliyanKordev Nov 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sebastianpfischer commented Nov 16, 2023

Uh oh!

sebastianpfischer commented Nov 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sebclrsn Nov 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sebclrsn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IliyanKordev commented Nov 29, 2023

Uh oh!

sebclrsn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov Bot commented Nov 15, 2023 •

edited

Loading

IliyanKordev Nov 15, 2023 •

edited

Loading

sebclrsn Nov 24, 2023 •

edited

Loading