List for cgit developers and users
 help / color / mirror / Atom feed
From: Sergey Bronnikov <s@brnkv.ru>
To: John Keeping <john@keeping.me.uk>, Sergey Bronnikov <estetus@gmail.com>
Cc: cgit@lists.zx2c4.com
Subject: Re: [PATCH 0/2] Support of test results
Date: Sun, 10 Oct 2021 20:51:33 +0300	[thread overview]
Message-ID: <0bce2d8f-19b0-51fb-1240-5993c2fb6d10@brnkv.ru> (raw)
In-Reply-To: <YV7A8Wh9ST4Zshkm@keeping.me.uk>


On 07.10.2021 12:42, John Keeping wrote:
> On Mon, Oct 04, 2021 at 01:22:34PM +0300, Sergey Bronnikov wrote:
>> From: Sergey Bronnikov <estetus@gmail.com>
>>
>> Git SCM allows to store information in so called notes [1] and cgit
>> allows to show notes that placed to default reference
>> ('refs/notes/commits') and attached to certain commits. It is convenient
>> to add various useful information related to commit in Git notes.
>>
>> Often tests results stored for future analysis in different systems (aka
>> 'test report systems'). But one is the logic places to store test
>> results is a Git SCM, test report automatically connected to commits and
>> easily available for everyone. It even can be automated using git-test [2].
> This feels very specifc to one use case that isn't particularly general.
> Have you considered any way to make this more generic for displaying
> different notes for different purposes?

In my experience different tools uses different git notes ref and

it cannot be changed. For example: "git appraise" uses

refs/notes/devtools/reviews, gerrit uses refs/notes/review

and google-git-notes-publisher-plugin uses refs/notes/devtools/ci.

I can make git note ref configurable. Will make it more general feature?

> Did you experiment with changing notes.displayRef in gitconfing and
> using the existing commit filter to display those inline in the commit
> page?

Sure, I know about default notes and experimented with commit filters a bit.

I don't like to store test results in default ref because:

- often test report has a long list of tests and it is inconvenient to 
scroll down it on cgit commit page.

- it is inconvenient to parse test report format when it is mixed with 
commit message,

>
>> How-to use:
>>
>> $ cat report.tap
>> 1..2
>> ok 1 - test_0.py::test_list_once
>> ok 2 - test_0.py::test_list_twice
>> $ GIT_NOTES_REF=refs/notes/testres git notes add -F report.tap 95aa7d200ee10580c472a1156a11c726046b110f
>> $ git notes add -m 'Tested-by: Sergey Bronnikov <estetus@gmail.com>' \
>> 	    2a3a0d1a62de2ae5ab4511c15d82a6a0f2c2a930
>> $ GIT_NOTES_REF=refs/notes/testres git show 95aa7d200ee10580c472a1156a11c726046b110f
>>
>> commit 95aa7d200ee10580c472a1156a11c726046b110f
>> Author: Sergey Bronnikov <sergeyb@tarantool.org>
>> Date:   Tue Dec 22 10:06:10 2020 +0300
>>
>> ...
>>
>> Notes (testres):
>>      1..2
>>      ok 1 - test_0.py::test_list_once
>>      ok 2 - test_0.py::test_list_twice
>>
>> Test report become available in cgit by clicking to href 'tests' for
>> that commit.
>>
>> 1. https://git-scm.com/docs/git-notes
>> 2. https://github.com/ligurio/git-test
>> 3. https://github.com/ligurio/testres/wiki/Using-GIT-as-a-storage
>>
>> Sergey Bronnikov (2):
>>    ui-commit: add support of test results
>>    ui-commit: add testres filter
>>
>>   cgit.c                      |  6 +++
>>   cgit.h                      |  4 +-
>>   cgitrc.5.txt                | 17 +++++++++
>>   cmd.c                       |  8 +++-
>>   filter.c                    |  6 +++
>>   filters/testres-example.lua | 21 +++++++++++
>>   shared.c                    |  1 +
>>   tests/setup.sh              |  2 +
>>   tests/t0105-commit.sh       |  7 ++++
>>   tests/t0111-filter.sh       |  8 ++++
>>   ui-commit.c                 | 73 ++++++++++++++++++++++++++++++++++++-
>>   ui-commit.h                 |  1 +
>>   ui-shared.c                 |  8 +++-
>>   ui-shared.h                 |  3 ++
>>   14 files changed, 161 insertions(+), 4 deletions(-)
>>   create mode 100755 filters/testres-example.lua
>>
>> -- 
>> 2.25.1
>>

      reply	other threads:[~2021-10-10 17:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-04 10:22 Sergey Bronnikov
2021-10-04 10:22 ` [PATCH 2/2] ui-commit: add testres filter Sergey Bronnikov
2021-10-05  9:56 ` [PATCH 0/2] Support of test results Sergey Bronnikov
2021-10-07  9:42 ` John Keeping
2021-10-10 17:51   ` Sergey Bronnikov [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0bce2d8f-19b0-51fb-1240-5993c2fb6d10@brnkv.ru \
    --to=s@brnkv.ru \
    --cc=cgit@lists.zx2c4.com \
    --cc=estetus@gmail.com \
    --cc=john@keeping.me.uk \
    --subject='Re: [PATCH 0/2] Support of test results' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).