From: Lady Date: Tue, 18 Mar 2025 04:01:20 +0000 (-0400) Subject: Build testing infrastructure X-Git-Url: https://git.ladys.computer/CGirls/commitdiff_plain/091679702255610d868b06af26ffa0ba5a6bf6d7 Build testing infrastructure For the actual testing script, see `sh/test.sh´, but note the following details :— • The file `cgirls.h´ has been renamed `aa.h´ because it will be needed in test binaries as well. • Source files are now automatically found rather than needing to list them explicitly in `make/cgirls.mak´. • Support for a `make/config.mak´ configuration file was added, for modifying the build. A sample is provided which offers the sort of optimizations one might want in a production environment. • Tests consist of comparing result of running a program with the input in `test/´ against an expected output in `expect/´. Lines which start with a `#´ are ignored in both. This is to enable REUSE‐conformance (all of these files are `CC0-1.0´) and hopefully will not cause problems down the road. --- diff --git a/.gitignore b/.gitignore index bd53857..16119d3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,7 @@ VERSION .depend *.o cgirls +cgirls-test-* +!cgirls-test-*.c +make/config.mak +test/*/logs diff --git a/GNUmakefile b/GNUmakefile index 62744ce..bd9639b 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -10,7 +10,7 @@ GITDIR := Git CGIRLS_VERSION := 0.1.0 GIT_VERSION := 2.49.0 -all : cgirls ; +all : cgirls cgirls-tests ; -include $(GITDIR)/config.mak.uname -include $(GITDIR)/shared.mak @@ -18,10 +18,14 @@ all : cgirls ; VERSION : $(QUIET_SUBDIR0)Git $(QUIET_SUBDIR1) -f ../make/cgirls.mak ../VERSION -cgirls : +cgirls cgirls-tests : $(QUIET_SUBDIR0)Git $(QUIET_SUBDIR1) -f ../make/cgirls.mak $@ $(EXTRA_GIT_TARGETS) NO_PERL=1 NO_GITWEB=1 NO_PYTHON=1 NO_TCLTK=1 NO_GETTEXT=1 NO_EXPAT=1 NO_CURL=1 +cgirls-test-% : FORCE + $(QUIET_SUBDIR0)Git $(QUIET_SUBDIR1) -f ../make/cgirls.mak ../$@ $(EXTRA_GIT_TARGETS) NO_PERL=1 NO_GITWEB=1 NO_PYTHON=1 NO_TCLTK=1 NO_GETTEXT=1 NO_EXPAT=1 NO_CURL=1 + $(GITDIR)/shared.mak : %/shared.mak : FORCE $(GIT) submodule update --init '$*' -.PHONY : VERSION all cgirls +FORCE : ; +.PHONY : FORCE VERSION all cgirls cgirls-tests ; diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/MPL-2.0.txt b/LICENSES/MPL-2.0.txt new file mode 100644 index 0000000..ee6256c --- /dev/null +++ b/LICENSES/MPL-2.0.txt @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/cgirls.h b/aa.h similarity index 60% rename from cgirls.h rename to aa.h index 123d277..9805423 100644 --- a/cgirls.h +++ b/aa.h @@ -1,9 +1,11 @@ // SPDX-FileCopyrightText: 2025 Lady // SPDX-License-Identifier: GPL-2.0-only -#ifndef CGIRLS_CGIRLS_H -#define CGIRLS_CGIRLS_H +#ifndef CGIRLS_AA_H +#define CGIRLS_AA_H + +// Common, shared dependencies. #include -#endif /* CGIRLS_CGIRLS_H */ +#endif /* CGIRLS_AA_H */ diff --git a/cgirls.c b/cgirls.c index 941ec95..fb3af65 100644 --- a/cgirls.c +++ b/cgirls.c @@ -1,7 +1,7 @@ // SPDX-FileCopyrightText: 2025 Lady // SPDX-License-Identifier: GPL-2.0-only -#include "cgirls.h" +#include "aa.h" int cmd_main(int argc, [[maybe_unused]] const char* argv[argc+1]) { return EXIT_SUCCESS; diff --git a/make/cgirls.mak b/make/cgirls.mak index 53766b5..ccbc9eb 100644 --- a/make/cgirls.mak +++ b/make/cgirls.mak @@ -12,7 +12,7 @@ SHELL = /bin/sh # The variable `CGIRLSDIR´ is used to point back to the directory containing the C·Girls code. CGIRLSDIR := .. cgirls : $(CGIRLSDIR)/cgirls -PHONY : cgirls +.PHONY : cgirls include Makefile # The `gen-version.sh´ script updates the `VERSION´ file when·ever the version changes. @@ -20,7 +20,7 @@ include Makefile $(CGIRLSDIR)/VERSION : VERSIONFORCE @cd '$(CGIRLSDIR)' && $(SHELL_PATH_SQ) sh/gen-version.sh VERSION VERSIONFORCE : ; -PHONY : VERSIONFORCE +.PHONY : VERSIONFORCE -include $(CGIRLSBUILDDIR)/VERSION # `CGIRLS_CFLAGS´ is a separate variable so that it can be tracked separately, to avoid rebuilding all of Git when these variables change. @@ -33,11 +33,13 @@ CGIRLS_SOURCE_FILES := $(shell cd '$(CGIRLSDIR)' && $(SOURCES_CMD)) CGIRLS_H_SOURCES = $(filter %.h,$(CGIRLS_SOURCE_FILES)) # `CGIRLS_OBJS´ lists the object files which this make·file is expected to create. -# These are listed one per line to make merges easier. -# `CGIRLSBUILDDIR´ is added as a prefix at the end. -CGIRLS_OBJS := -CGIRLS_OBJS += cgirls.o -CGIRLS_OBJS := $(addprefix $(CGIRLSDIR)/,$(CGIRLS_OBJS)) +# `CGIRLS_TESTOBJS´ lists the additional object files used for the testing programs. +CGIRLS_OBJS := $(patsubst %.c,%.o,$(shell find '$(CGIRLSDIR)' '(' -path '$(CGIRLSDIR)' -o -prune ')' -a -type f -a -name '*.c' -a '!' -name 'cgirls-test-*.c')) +CGIRLS_TESTOBJS := $(patsubst %.c,%.o,$(shell find '$(CGIRLSDIR)' '(' -path '$(CGIRLSDIR)' -o -prune ')' -a -type f -a -name 'cgirls-test-*.c')) +CGIRLS_TESTS := $(patsubst %.o,%,$(CGIRLS_TESTOBJS)) + +# `CGIRLS_ALLOBJS´ contains both `CGIRLS_OBJS´ and `CGIRLS_TESTOBJS´. +CGIRLS_ALLOBJS = $(CGIRLS_OBJS) $(CGIRLS_TESTOBJS) # Only `cgirls.c´ references CGIRLS_VERSION so we only rebuild its objects when the version changes. CGIRLS_VERSION_OBJS := $(CGIRLSDIR)/cgirls.o @@ -47,8 +49,8 @@ $(CGIRLS_VERSION_OBJS) : EXTRA_CPPFLAGS = \ # Git handles dependencies using `:=´, so they have already been computed by this point. # We have to manage the dependency files for `CGIRLS_OBJS´ ourselves. -cgirls_dep_files := $(foreach f,$(CGIRLS_OBJS),$(dir $f).depend/$(notdir $f).d) -cgirls_dep_dirs := $(addsuffix .depend,$(sort $(dir $(CGIRLS_OBJS)))) +cgirls_dep_files := $(foreach f,$(CGIRLS_ALLOBJS),$(dir $f).depend/$(notdir $f).d) +cgirls_dep_dirs := $(addsuffix .depend,$(sort $(dir $(CGIRLS_ALLOBJS)))) ifeq ($(COMPUTE_HEADER_DEPENDENCIES),yes) $(cgirls_dep_dirs) : @mkdir -p $@ @@ -60,9 +62,13 @@ ifneq ($(cgirls_dep_files_present),) include $(cgirls_dep_files_present) endif else -$(CGIRLS_OBJS) : $(CGIRLS_H_SOURCES) $(LIB_H) $(GENERATED_H) +$(CGIRLS_ALLOBJS) : $(CGIRLS_H_SOURCES) $(LIB_H) $(GENERATED_H) endif +# At this point, all the variables have been defined. +# Include custom modifications, if defined. +-include $(CGIRLSDIR)/make/config.mak + # This saves the value of `CGIRLS_CFLAGS´ to force a rebuild of `CGIRLS_OBJS´ if the flags should change. $(CGIRLSDIR)/CGIRLS-CFLAGS : FORCE @FLAGS='$(subst ','"'"',$(CGIRLS_CFLAGS))'; \ @@ -72,7 +78,11 @@ $(CGIRLSDIR)/CGIRLS-CFLAGS : FORCE fi # Objects are built and linked the same as with Git, except depending on the additional `CGIRLS-CFLAGS´ file and using `ALL_CGIRLS_CFLAGS´ in place of `ALL_CFLAGS´. -$(CGIRLS_OBJS) : $(CGIRLSDIR)/%.o : $(CGIRLSDIR)/%.c GIT-CFLAGS $(CGIRLSDIR)/CGIRLS-CFLAGS $(missing_dep_dirs) +$(CGIRLS_ALLOBJS) : $(CGIRLSDIR)/%.o : $(CGIRLSDIR)/%.c GIT-CFLAGS $(CGIRLSDIR)/CGIRLS-CFLAGS $(missing_dep_dirs) $(QUIET_CC)$(CC) -o $@ -c $(dep_args) $(ALL_CGIRLS_CFLAGS) $(EXTRA_CPPFLAGS) $< $(CGIRLSDIR)/cgirls : $(CGIRLS_OBJS) GIT-LDFLAGS $(GITLIBS) - $(QUIET_LINK)$(CC) $(ALL_CGIRLS_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(sort $(LIBS)) + $(QUIET_LINK)$(CC) $(ALL_CGIRLS_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(LIBS) +$(CGIRLS_TESTS) : $(CGIRLSDIR)/% : $(CGIRLSDIR)/%.o $(filter-out $(CGIRLSDIR)/cgirls.o,$(CGIRLS_OBJS)) GIT-LDFLAGS $(GITLIBS) + $(QUIET_LINK)$(CC) $(ALL_CGIRLS_CFLAGS) -o $@ $(ALL_LDFLAGS) $(filter %.o,$^) $(LIBS) +cgirls-tests : $(CGIRLS_TESTS) ; +.PHONY : cgirls-tests diff --git a/make/config-sample.mak b/make/config-sample.mak new file mode 100644 index 0000000..be9b21f --- /dev/null +++ b/make/config-sample.mak @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2025 Lady +# SPDX-License-Identifier: CC0-1.0 + +# Sample code to generate a more optimized build, assuming Clang as the +# compiler. +# +# • `-DNDEBUG´ drops `assert()´ functionality. +# +# • `-O3´ sets the level of optimization to maximum. +# +# • `-flto´ enables link‐time optimization. +# +# • `-g0´ drops debugging information. +CFLAGS := $(filter-out -O% -g -g%,$(CFLAGS)) \ + -DNDEBUG -O3 -flto -g0 diff --git a/sh/gen-version.sh b/sh/gen-version.sh old mode 100644 new mode 100755 diff --git a/sh/test.sh b/sh/test.sh new file mode 100755 index 0000000..fc0935b --- /dev/null +++ b/sh/test.sh @@ -0,0 +1,110 @@ +#!/bin/sh +# SPDX-FileCopyrightText: 2025 Lady +# SPDX-License-Identifier: MPL-2.0 + +# This Source Code Form is subject to the terms of the Mozilla Public License, v 2.0. +# If a copy of the M·P·L was not distributed with this file, You can obtain one at . + +# The program name is used in rendering the output. +PROGRAM_NAME=$0 +# The first argument specifies the test program(s) to use. +TEST_PROGRAMS=$1 +# The second argument specifies the test(s) to run. +TEST_FILES=$2 + +TEST_EXIT_STATUS=0 +TEST_PROGRAM_PREFIX=cgirls-test- + +# If no test programs are specified, find all of them by looking for files which start with `cgirls-test-´ and end in `.c´. +if test -z "${TEST_PROGRAMS}" +then : + TEST_PROGRAMS=$(find . '(' -path '.' -o -prune ')' -a -type f -a -name "${TEST_PROGRAM_PREFIX}"'*.c' | sed 's|^\./'"${TEST_PROGRAM_PREFIX}"'||;s|\.c$||') +fi + +# Iterate over the test programs and run the tests. +# This code first gets the list of available tests (via another `find´) and saves it as the `.index´ in the test directory. +# Tests must have names which start with two digits and a hymin. +# If a specific test was not requested, all tests are run. +# Otherwise, only those tests which match one of the specified tests will run. +for test_program in ${TEST_PROGRAMS} +do : + printf '\033[1;4m %-45s \033[0m\n' "${PROGRAM_NAME} ${test_program}" + if test '!' -x "${TEST_PROGRAM_PREFIX}${test_program}" + then : + printf '%b\n' '\0033[1;93;41;m[ERROR]\0033[0m Test program has not been compiled.\n\033[7m \033[0m (Try \0033[3mmake '"${TEST_PROGRAM_PREFIX}${test_program}"'\0033[23m.)' + TEST_EXIT_STATUS=$((${TEST_EXIT_STATUS} | 4)) + else : + if test '!' -d "test/${test_program}/logs" + then : + mkdir -p "test/${test_program}/logs" + fi + if test '!' -d "expect/${test_program}" + then : + mkdir -p "expect/${test_program}" + fi + AVAILABLE_TEST_FILES=$(LC_ALL=POSIX find "test/${test_program}" '(' -path "test/${test_program}" -o -prune ')' -a -type f -a -name '[0-9][0-9]-*' | sed 's|^[^/]*/[^/]*/||' | sort -) + printf '%s\n' $AVAILABLE_TEST_FILES >|'test/'"${test_program}"'/logs/!!INDEX!!' + if test -z "${TEST_FILES}" + then : + SELECTED_TEST_FILES=${AVAILABLE_TEST_FILES} + else : + SELECTED_TEST_FILES=$(LC_ALL=POSIX printf '%s\n' ${TEST_FILES} | sort - | comm -1 -2 - 'test/'"${test_program}"'/logs/!!INDEX!!') + fi + for test_file in ${SELECTED_TEST_FILES} + do : + printf '\033[7m \033[0m \033[3m%-34s\033[0m ' "${PROGRAM_NAME} ${test_program} ${test_file}" + TEST_RESULT="$(sed '/# /d' <"test/${test_program}/${test_file}" | "./${TEST_PROGRAM_PREFIX}${test_program}" 2>|"test/${test_program}/logs/${test_file}")" + TEST_LOG="$(cat "test/${test_program}/logs/${test_file}")" + if test -n "${TEST_LOG}" + then : + printf '%27b \n' '\0033[1;93;41;m[NG]\0033[0m' + printf '\033[7m \033[0m \033[2m%b\033[0m \n' "${TEST_LOG}" + TEST_EXIT_STATUS=$((${TEST_EXIT_STATUS} | 1)) + else : + if test -n "$SET_EXPECTATION" + then : + sed '/# SPDX-/!d' <"test/${test_program}/${test_file}" >|"expect/${test_program}/${test_file}" + printf '%s\n' "${TEST_RESULT}" >>"expect/${test_program}/${test_file}" + printf '%27b\n' '\0033[1;93;45;m[SAVED]\0033[0m' + else : + if test '!' -f "expect/${test_program}/${test_file}" + then : + printf '%27b\n' '\033[1;93;44;m[UNEXPECTED]\0033[0m' + printf '\033[7m \033[0m \033[2m%b\033[0m \n' 'Run with \0033[3mSET_EXPECTATION=1\0033[23m to set an' 'expectation.' + TEST_EXIT_STATUS=$((${TEST_EXIT_STATUS} | 2)) + else : + TEST_EXPECTATION="$(sed '/# /d' <"expect/${test_program}/${test_file}")" + if test "${TEST_RESULT}" '=' "${TEST_EXPECTATION}" + then : + printf '%27b \n' '\0033[1;93;42;m[OK]\0033[0m' + else : + printf '%27b \n' '\0033[1;93;41;m[NG]\0033[0m' + printf '\033[7m \033[0m \033[2m%b\033[0m \n' 'Result did not match expectation.' 'Got:' + printf '\033[30;107m%-49s\033[0m\n' "${TEST_RESULT}" + printf '\033[7m \033[0m \033[2m%b\033[0m \n' 'Expected:' + printf '\033[30;107m%-49s\033[0m\n' "${TEST_EXPECTATION}" + TEST_EXIT_STATUS=$((${TEST_EXIT_STATUS} | 1)) + fi + fi + fi + fi + done + fi + if test ${TEST_EXIT_STATUS} -eq 0 + then : + printf '\033[1m%s\033[0m\n' 'All tests succeeded.' + fi + if test $((${TEST_EXIT_STATUS} & 1)) -gt 0 + then : + printf '\033[1m%s\033[0m\n' 'Not all tests completed successfully.' + fi + if test $((${TEST_EXIT_STATUS} & 2)) -gt 0 + then : + printf '\033[1m%s\033[0m\n' 'At least one test was unexpected.' + fi + if test $((${TEST_EXIT_STATUS} & 4)) -gt 0 + then : + printf '\033[1m%s\033[0m\n' 'At least one test program needs to be built.' + fi + exit ${TEST_EXIT_STATUS} +done