Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210922163921.2462565-1-dlatypov@google.com>
In-Reply-To: <20210922163921.2462565-1-dlatypov@google.com>
From:   Brendan Higgins <brendanhiggins@google.com>
Date:   Tue, 28 Sep 2021 14:24:01 -0700
Message-ID: <CAFd5g44441Qv0tzSbRdz1nOcZLEuSVdHRh71SjbpLN=c44+gnw@mail.gmail.com>
Subject: Re: [PATCH v2] kunit: tool: better handling of quasi-bool args
 (--json, --raw_output)
To:     Daniel Latypov <dlatypov@google.com>
Cc:     davidgow@google.com, linux-kernel@vger.kernel.org,
        kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org,
        skhan@linuxfoundation.org
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Sep 22, 2021 at 9:39 AM Daniel Latypov <dlatypov@google.com> wrote:
>
> Problem:
>
> What does this do?
> $ kunit.py run --json
> Well, it runs all the tests and prints test results out as JSON.
>
> And next is
> $ kunit.py run my-test-suite --json
> This runs just `my-test-suite` and prints results out as JSON.
>
> But what about?
> $ kunit.py run --json my-test-suite
> This runs all the tests and stores the json results in a "my-test-suite"
> file.
>
> Why:
> --json, and now --raw_output are actually string flags. They just have a
> default value. --json in particular takes the name of an output file.
>
> It was intended that you'd do
> $ kunit.py run --json=my_output_file my-test-suite
> if you ever wanted to specify the value.
>
> Workaround:
> It doesn't seem like there's a way to make
> https://docs.python.org/3/library/argparse.html only accept arg values
> after a '='.
>
> I believe that `--json` should "just work" regardless of where it is.
> So this patch automatically rewrites a bare `--json` to `--json=stdout`.
>
> That makes the examples above work the same way.
> Add a regression test that can catch this for --raw_output.
>
> Fixes: 6a499c9c42d0 ("kunit: tool: make --raw_output support only showing kunit output")
> Signed-off-by: Daniel Latypov <dlatypov@google.com>
> Tested-by: David Gow <davidgow@google.com>

Reviewed-by: Brendan Higgins <brendanhiggins@google.com>