Re: [TCLCORE] Project tk_collect_test_utils, report and invitation for final review

[Harald O. <har...@el...>]

Eric,
I think, we may address this in the biweekly telco of today.
Would it be possible for you to attend?

Thanks and take care,
Harald

Am 06.04.2025 um 23:21 schrieb Erik Leunissen:
> L.S.
> 
> The project tk_collect_test_utils [1] has been underway for several months,
> and has now reached a stage where it does what it's meant to do.
> It is ready for a final review.
> 
> This post invites comments from maintainers and other knowledgeable 
> developers
> frequenting this mailing list, especially those who are concerned with Tk.
> 
> General information
> -------------------
> The project's ticket is at:
> 
>          https://core.tcl-lang.org/tk/tktview/718cbc3016
> 
>    The very first post in the ticket describes the project's purpose, and
>    adjustments made along the way. The rest of the ticket serves as a 
> course
>    project log.
> 
> The implementation is in the development branch at:
> 
> https://core.tcl-lang.org/tk/timeline?r=tk_collect_test_utils
> 
>    The current tip of the development branch is meant for inspection and
>    possibly exercising. To indicate its correspondence to this post, that
>    particular check-in has been tagged "FINAL_REVIEW".
> 
> The development of this project took place in close consultation with
> François Vogel [2].
> 
> An overview of the project's results
> ------------------------------------
> * test constraints and utility procs that were used in multiple test files,
>    have been relocated/collected; the utility procs in a new file
>    "tests/testutils.tcl", the test constraints in the already existing file
>    "constraints.tcl". What's left in test files are constraints and utility
>    procs that are used only in a single test file.
> * the loading of top-level scripts by the Tk test suite has been 
> restructured.
>    This was necessary to enable the loading of multiple scripts with 
> entirely
>    different functionality. The initial script loaded by test files in 
> the Tk
>    test suite is now "main.tcl", which in turn takes care of loading
>    "testutils.tcl" and "constraints.tcl".
> * test files that make use of collected utility procs have a command
>    "testutils import xxx" inserted near the top of the file, and a 
> corresponding
>    "testutils forget xxx" at the end of the file. The "xxx" in these 
> invocations
>    stands for a certain functional area.
> * the mechanism for importing/forgetting utility procs, including the proc
>    "testutils", has been documented in the file "tests/testutils.GUIDE".
> * the correct functioning of the proc "testutils" is tested in a 
> separate test
>    file "tests/testutils.test".
> * the Tk test suite, as adjusted in this project, passes with CI runs at 
> Github.
> 
> 
> Procedure (in consultation with François)
> -----------------------------------------
> I'm asking that responses be directed to this mailing list within three 
> weeks.
> Please note that there is an intent to merge the development branch into
> trunk. In the eventuality of no responses to this post, the merge will 
> happen
> after the period of three weeks.
> 
> My advice to reviewers: read the initial post in the ticket and the 
> documentation
> in "tests/testutils.GUIDE" before anything else.
> 
> Of course, I'm prepared to provide clarification if needed.
> 
> Thanks in advance for your attention,
> Erik Leunissen
> -- 
> 
> [1] On Tue, 17 Dec 2024 12:12, I announced the start of this effort/job
>      in this mailing list (as part of a larger proposal that was mailed 
> before
>      that date). In the meantime, the project has been dubbed 
> "tk_collect_test_utils".
> [2] Besides providing excellent guidance for me, being new to fossil and 
> the Tk
>      repository, François' advice was especially valuable where 
> development met with
>      choices that were nontrivial, but where no policy preexisted to 
> rely on.
> 
> 
> 
> _______________________________________________
> Tcl-Core mailing list
> Tcl...@li...
> https://lists.sourceforge.net/lists/listinfo/tcl-core


-- 
ELMICRON Dr. Harald Oehlmann GmbH
Koesener Str. 85
06618 NAUMBURG - Germany
Phone: +49 3445 781120
Direct: +49 3445 781127
www.Elmicron.de
German legal references:
Geschaeftsfuehrer: Dr. Harald Oehlmann
UST Nr. / VAT ID No.: DE206105272
HRB 212803 Stendal