fmartingr/dharma
fmartingr/dharma
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

initial release
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
Details

Browse source
This commit is contained in:
Felipe M 2025-05-04 10:40:26 +02:00
commit 0ef15167d5
Signed by: fmartingr
GPG key ID: CCFBC5637D4000A8
28 changed files with 2789 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
.gitignore vendored Normal file
View file

@ -0,0 +1,30 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib
/dharma
/result.csv
# Test binary, built with `go test -c`
*.test
# Output of the go coverage tool, specifically when used with LiteIDE
*.out
# Dependency directories (remove the comment below to include it)
# vendor/
# Go workspace file
go.work
# IDE specific files
.idea/
.vscode/
*.swp
*.swo
# OS specific files
.DS_Store
Thumbs.db

108
.goreleaser.yml Normal file
View file

@ -0,0 +1,108 @@
version: 2
gitea_urls:
api: https://git.nakama.town/api/v1
download: https://git.nakama.town
before:
hooks:
- go mod tidy
git:
ignore_tags:
- "{{ if not .IsNightly }}*-rc*{{ end }}"
builds:
- binary: dharma
main: ./cmd/dharma
env:
- CGO_ENABLED=0
- GIN_MODE=release
tags:
- netgo
- osusergo
goos:
- linux
- windows
- darwin
goarch:
- amd64
- arm
- arm64
goarm:
- "7"
ignore:
- goos: darwin
goarch: arm
- goos: windows
goarch: arm
- goos: windows
goarch: arm64
archives:
- id: dharma
name_template: >-
{{ .ProjectName }}_
{{- if eq .Os "darwin" }}Darwin{{- else if eq .Os "linux" }}Linux{{- else if eq .Os "windows" }}Windows{{- else }}{{ .Os }}{{ end }}_
{{- if eq .Arch "amd64" }}x86_64{{- else if eq .Arch "arm64" }}aarch64{{- else }}{{ .Arch }}{{ end }}_{{ .Version }}
format_overrides:
- goos: windows
format: zip
nfpms:
- maintainer: Felipe Martin <me@fmartingr.com>
description: A tool to check the accessibility of links in a website
homepage: https://git.nakama.town/fmartingr/dharma
license: GPL-3.0
formats:
- deb
- rpm
- apk
upx:
- enabled: true
ids:
- dharma
goos: [linux, darwin]
goarch: [amd64, arm, arm64]
goarm: ["7"]
checksum:
name_template: "checksums.txt"
snapshot:
version_template: "{{ incpatch .Version }}-next"
changelog:
sort: asc
groups:
- title: Features
regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
order: 0
- title: "Fixes"
regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
order: 1
- title: "Performance"
regexp: '^.*?perf(\([[:word:]]+\))??!?:.+$'
order: 2
- title: API
regexp: '^.*?api(\([[:word:]]+\))??!?:.+$'
order: 3
- title: Documentation
regexp: '^.*?docs(\([[:word:]]+\))??!?:.+$'
order: 4
- title: "Tests"
regexp: '^.*?test(\([[:word:]]+\))??!?:.+$'
order: 5
- title: CI and Delivery
regexp: '^.*?ci(\([[:word:]]+\))??!?:.+$'
order: 6
- title: Others
order: 999
filters:
exclude:
- "^deps:"
- "^chore\\(deps\\):"
release:
prerelease: auto

23
.woodpecker/ci.yml Normal file
View file

@ -0,0 +1,23 @@
when:
event:
- push
- pull_request
branch:
- main
steps:
format:
image: golang:1.24.2
commands:
- make format
- git diff --exit-code # Fail if files were changed
lint:
image: golang:1.24.2
commands:
- make ci-lint
test:
image: golang:1.24.2
commands:
- make test

12
.woodpecker/release.yml Normal file
View file

@ -0,0 +1,12 @@
when:
- event: tag
branch: main
steps:
- name: Release
image: goreleaser/goreleaser:v2.9.0
environment:
GITEA_TOKEN:
from_secret: GITEA_TOKEN
commands:
- goreleaser release --clean

232
LICENSE Normal file
View file

@ -0,0 +1,232 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS
0. Definitions.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
smtp2shoutrrr
Copyright (C) 2024 fmartingr
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
smtp2shoutrrr Copyright (C) 2024 fmartingr
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>.

100
Makefile Normal file
View file

@ -0,0 +1,100 @@
PROJECT_NAME := dharma
SOURCE_FILES ?=./...
TEST_OPTIONS ?= -v -failfast -race -bench=. -benchtime=100000x -cover -coverprofile=coverage.out
TEST_TIMEOUT ?=1m
GOLANGCI_LINT_VERSION ?= v1.64.5
CLEAN_OPTIONS ?=-modcache -testcache
CGO_ENABLED := 0
BUILDS_PATH := ./dist
FROM_MAKEFILE := y
CONTAINERFILE_NAME := Containerfile
CONTAINER_ALPINE_VERSION := 3.20
CONTAINER_SOURCE_URL := "https://git.nakama.town/fmartingr/${PROJECT_NAME}"
CONTAINER_MAINTAINER := "Felipe Martin <me@fmartingr.com>"
CONTAINER_BIN_NAME := ${PROJECT_NAME}
BUILDX_PLATFORMS := linux/amd64,linux/arm64,linux/arm/v7
export PROJECT_NAME
export FROM_MAKEFILE
export CGO_ENABLED
export SOURCE_FILES
export TEST_OPTIONS
export TEST_TIMEOUT
export BUILDS_PATH
export CONTAINERFILE_NAME
export CONTAINER_ALPINE_VERSION
export CONTAINER_SOURCE_URL
export CONTAINER_MAINTAINER
export CONTAINER_BIN_NAME
export BUILDX_PLATFORMS
.PHONY: all
all: help
# this is godly
# https://news.ycombinator.com/item?id=11939200
.PHONY: help
help: ### this screen. Keep it first target to be default
ifeq ($(UNAME), Linux)
@grep -P '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
else
@# this is not tested, but prepared in advance for you, Mac drivers
@awk -F ':.*###' '$$0 ~ FS {printf "%15s%s\n", $$1 ":", $$2}' \
$(MAKEFILE_LIST) | grep -v '@awk' | sort
endif
.PHONY: clean
clean: ### clean test cache, build files
$(info: Make: Clean)
@rm -rf ${BUILDS_PATH}
@go clean ${CLEAN_OPTIONS}
@-docker buildx rm ${PROJECT_NAME}_builder
.PHONY: build
build: clean ### builds the project for the setup os/arch combinations
$(info: Make: Build)
@goreleaser --clean --snapshot
.PHONY: quick-run
quick-run: ### Executes the project using golang
CGO_ENABLED=${CGO_ENABLED} go run ./cmd/${PROJECT_NAME}/*.go
.PHONY: run
run: ### Executes the project build locally
@make build
${BUILDS_PATH}/${PROJECT_NAME}
.PHONY: format
format: ### Executes the formatting pipeline on the project
$(info: Make: Format)
@go fmt ./...
@go mod tidy
.PHONY: ci-lint
ci-lint: ### Check the project for errors
$(info: Make: Lint)
@go install github.com/golangci/golangci-lint/cmd/golangci-lint@${GOLANGCI_LINT_VERSION}
@golangci-lint run ./...
.PHONY: lint
lint: ### Check the project for errors
$(info: Make: Lint)
@golangci-lint run ./...
.PHONY: test
test: ### Runs the test suite
$(info: Make: Test)
CGO_ENABLED=1 go test ${TEST_OPTIONS} -timeout=${TEST_TIMEOUT} ${SOURCE_FILES}

72
README.md Normal file
View file

@ -0,0 +1,72 @@
# Dharma
A website link checker that crawls websites to find broken links, images, CSS references, and more.
## Features
- Crawls websites and checks for broken links, images, stylesheets, and other references
- Checks both internal and external links
- Supports CSS file scanning for `@import` and `url()` references
- Concurrent requests for faster scanning
- Multiple output formats (pretty terminal output, JSON, CSV)
- Configurable scan depth, concurrency, and timeout
## Installation
### From Source
```bash
git clone git.nakama.town/fmartingr/dharma
cd dharma
go install ./cmd/dharma
```
## Usage
```bash
# Basic usage (defaults to 'pretty' output format)
dharma https://example.com
# Use JSON output format
dharma --format json https://example.com
# Increase concurrency and depth
dharma --concurrency 20 --depth 5 https://example.com
# Increase timeout for slow sites
dharma --timeout 30 https://example.com
# Enable verbose output
dharma --verbose https://example.com
```
### Command Line Options
- `--format, -f`: Output format (pretty, json, csv) (default: "pretty")
- `--concurrency, -c`: Number of concurrent requests (default: 10)
- `--depth, -d`: Maximum depth to crawl (default: 3)
- `--timeout, -t`: Timeout in seconds for each request (default: 10)
- `--verbose, -v`: Enable verbose output
## Development
### Testing
The project includes a comprehensive test suite:
```bash
# Run all tests
go test -v ./...
# Run tests excluding integration tests
go test -v -short ./...
# Run testsite tests specifically
make test-testsite
```
A test site is included in the `testsite/` directory to test the tool against a controlled environment with known broken and working links. The test suite will start a local HTTP server for this test site and run the tool against it to verify its functionality.
## License
[LICENSE](LICENSE)

13
cmd/dharma/main.go Normal file
View file

@ -0,0 +1,13 @@
package main
import (
"os"
"git.nakama.town/fmartingr/dharma/pkg/cli"
)
func main() {
if err := cli.Execute(); err != nil {
os.Exit(1)
}
}

19
go.mod Normal file
View file

@ -0,0 +1,19 @@
module git.nakama.town/fmartingr/dharma
go 1.24.2
require (
github.com/PuerkitoBio/goquery v1.10.3
github.com/fatih/color v1.18.0
github.com/spf13/cobra v1.9.1
)
require (
github.com/andybalholm/cascadia v1.3.3 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/spf13/pflag v1.0.6 // indirect
golang.org/x/net v0.39.0 // indirect
golang.org/x/sys v0.32.0 // indirect
)

92
go.sum Normal file
View file

@ -0,0 +1,92 @@
github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo=
github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y=
github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM=
github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA=
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8=
golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY=
golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU=
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY=
golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

77
pkg/cli/root.go Normal file
View file

@ -0,0 +1,77 @@
package cli
import (
"fmt"
"os"
"git.nakama.town/fmartingr/dharma/pkg/reporter"
"git.nakama.town/fmartingr/dharma/pkg/scraper"
"github.com/spf13/cobra"
)
var (
format string
concurrency int
depth int
timeout int
verbose bool
internalOnly bool
)
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "dharma [URL]",
Short: "Scrape websites and check for broken links and references",
Long: `Dharma is a website link checker tool that crawls a website to find broken links,
images, CSS references, and more. It generates a report of all issues found.`,
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
url := args[0]
// Only print status message when using pretty format
if format == "pretty" {
fmt.Printf("Scanning website: %s\n", url)
} else {
// Force verbose off for non-pretty formats
verbose = false
}
// Create a new scraper
s := scraper.New(
scraper.WithConcurrency(concurrency),
scraper.WithDepth(depth),
scraper.WithTimeout(timeout),
scraper.WithVerbose(verbose),
scraper.WithInternalOnly(internalOnly),
)
// Run the scraper
results, err := s.Scan(url)
if err != nil {
return err
}
// Generate report
r, err := reporter.New(format)
if err != nil {
return err
}
return r.Generate(results, os.Stdout)
},
}
// Execute adds all child commands to the root command and sets flags appropriately.
// This is called by main.main(). It only needs to happen once to the rootCmd.
func Execute() error {
return rootCmd.Execute()
}
func init() {
rootCmd.Flags().StringVarP(&format, "format", "f", "pretty", "Output format (pretty, json, csv)")
rootCmd.Flags().IntVarP(&concurrency, "concurrency", "c", 10, "Number of concurrent requests")
rootCmd.Flags().IntVarP(&depth, "depth", "d", 3, "Maximum depth to crawl")
rootCmd.Flags().IntVarP(&timeout, "timeout", "t", 10, "Timeout in seconds for each request")
rootCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "Verbose output")
rootCmd.Flags().BoolVarP(&internalOnly, "internal-only", "i", false, "Only check internal links (same hostname)")
}

196
pkg/cli/testsite_test.go Normal file
View file

@ -0,0 +1,196 @@
package cli
import (
"bytes"
"fmt"
"os"
"strings"
"testing"
"git.nakama.town/fmartingr/dharma/pkg/reporter"
"git.nakama.town/fmartingr/dharma/pkg/scraper"
"git.nakama.town/fmartingr/dharma/pkg/testutil"
"github.com/spf13/cobra"
)
func TestIntegrationTestsite(t *testing.T) {
// Skip this test if running in CI environment or if it's a short test run
if testing.Short() {
t.Skip("Skipping integration test in short mode")
}
// Start the testsite server
serverURL, cleanup, err := testutil.StartTestsiteServer()
if err != nil {
t.Fatalf("Failed to start test server: %v", err)
}
defer cleanup()
// Test cases for CLI invocation with different flags
testCases := []struct {
name string
args []string
wantOutput bool
wantErrors bool
}{
{
name: "Basic scan",
args: []string{serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "JSON output",
args: []string{"--format", "json", serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "Internal links only",
args: []string{"--internal-only", serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "Custom depth",
args: []string{"--depth", "1", serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "Custom concurrency",
args: []string{"--concurrency", "1", serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "Custom timeout",
args: []string{"--timeout", "5", serverURL},
wantOutput: true,
wantErrors: true,
},
{
name: "CSV output",
args: []string{"--format", "csv", serverURL},
wantOutput: true,
wantErrors: true,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
// Temporarily replace stdout to capture output
oldStdout := os.Stdout
r, w, _ := os.Pipe()
os.Stdout = w
// Save and restore rootCmd so state doesn't leak between test cases
origRootCmd := rootCmd
defer func() {
rootCmd = origRootCmd
os.Stdout = oldStdout
}()
// Reset rootCmd for this test
rootCmd = createRootCmd()
// Set the command line arguments
os.Args = append([]string{"dharma"}, tc.args...)
// Execute the CLI
err := Execute()
if err != nil {
t.Fatalf("Failed to execute command: %v", err)
}
// Restore stdout and read the output
w.Close()
var buf bytes.Buffer
_, err = buf.ReadFrom(r)
if err != nil {
t.Fatalf("Failed to read output: %v", err)
}
output := buf.String()
// Check if we got any output
if tc.wantOutput && output == "" {
t.Errorf("Expected output but got none")
}
// Check if errors were reported for known broken links
if tc.wantErrors {
if !strings.Contains(output, "not_found.html") {
t.Errorf("Expected not_found.html to be reported as broken in output")
}
}
// Specific checks for different formats
if strings.Contains(tc.name, "JSON") {
if !strings.Contains(output, `"url":`) {
t.Errorf("Expected JSON output with 'url' field")
}
} else if strings.Contains(tc.name, "CSV") {
if !strings.Contains(output, "Status,Type,URL,Source URL,Error") {
t.Errorf("Expected CSV header in output")
}
}
})
}
}
// createRootCmd returns a fresh instance of the root command
func createRootCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "dharma [URL]",
Short: "Scrape websites and check for broken links and references",
Long: `Dharma is a website link checker tool that crawls a website to find broken links, images, CSS references, and more. It generates a report of all issues found.`,
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
url := args[0]
// Only print status message when using pretty format
if format == "pretty" {
if !strings.HasPrefix(url, "file://") {
fmt.Printf("Scanning website: %s\n", url)
} else {
fmt.Printf("Scanning local directory: %s\n", strings.TrimPrefix(url, "file://"))
}
} else {
// Force verbose off for non-pretty formats
verbose = false
}
// Create a new scraper
s := scraper.New(
scraper.WithConcurrency(concurrency),
scraper.WithDepth(depth),
scraper.WithTimeout(timeout),
scraper.WithVerbose(verbose),
scraper.WithInternalOnly(internalOnly),
)
// Run the scraper
results, err := s.Scan(url)
if err != nil {
return err
}
// Generate report
r, err := reporter.New(format)
if err != nil {
return err
}
return r.Generate(results, os.Stdout)
},
}
cmd.Flags().StringVarP(&format, "format", "f", "pretty", "Output format (pretty, json, csv)")
cmd.Flags().IntVarP(&concurrency, "concurrency", "c", 10, "Number of concurrent requests")
cmd.Flags().IntVarP(&depth, "depth", "d", 3, "Maximum depth to crawl")
cmd.Flags().IntVarP(&timeout, "timeout", "t", 10, "Timeout in seconds for each request")
cmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "Verbose output")
cmd.Flags().BoolVarP(&internalOnly, "internal-only", "i", false, "Only check internal links (same hostname)")
return cmd
}

192
pkg/reporter/reporter.go Normal file
View file

@ -0,0 +1,192 @@
package reporter
import (
"encoding/csv"
"encoding/json"
"fmt"
"io"
"strings"
"time"
"git.nakama.town/fmartingr/dharma/pkg/scraper"
"github.com/fatih/color"
)
// Reporter is an interface for report generators
type Reporter interface {
Generate(results *scraper.Results, writer io.Writer) error
}
// New creates a new reporter based on the format
func New(format string) (Reporter, error) {
switch strings.ToLower(format) {
case "pretty":
return &PrettyReporter{}, nil
case "json":
return &JSONReporter{}, nil
case "csv":
return &CSVReporter{}, nil
default:
return nil, fmt.Errorf("unsupported format: %s", format)
}
}
// PrettyReporter generates a human-readable report for terminal
type PrettyReporter struct{}
// Generate generates a pretty report
func (r *PrettyReporter) Generate(results *scraper.Results, writer io.Writer) error {
red := color.New(color.FgRed).SprintFunc()
green := color.New(color.FgGreen).SprintFunc()
yellow := color.New(color.FgYellow).SprintFunc()
blue := color.New(color.FgBlue).SprintFunc()
cyan := color.New(color.FgCyan).SprintFunc()
// Count internal vs external links
countInternalSuccess := 0
countInternalErrors := 0
countExternalSuccess := 0
countExternalErrors := 0
for _, result := range results.Successes {
if result.IsExternal {
countExternalSuccess++
} else {
countInternalSuccess++
}
}
for _, result := range results.Errors {
if result.IsExternal {
countExternalErrors++
} else {
countInternalErrors++
}
}
fmt.Fprintf(writer, "Website scan report for: %s\n", blue(results.BaseURL))
fmt.Fprintf(writer, "Scanned at: %s\n", time.Now().Format(time.RFC1123))
fmt.Fprintf(writer, "Total resources checked: %d\n", results.Total)
fmt.Fprintf(writer, "Success: %s, Errors: %s\n",
green(len(results.Successes)),
red(len(results.Errors)))
fmt.Fprintf(writer, "Internal links: %s success, %s errors\n",
green(countInternalSuccess),
red(countInternalErrors))
fmt.Fprintf(writer, "External links: %s success, %s errors\n\n",
green(countExternalSuccess),
red(countExternalErrors))
if len(results.Errors) == 0 {
fmt.Fprintf(writer, "%s No errors found!\n", green("✓"))
return nil
}
// Group errors by internal/external
internalErrors := []scraper.Result{}
externalErrors := []scraper.Result{}
for _, result := range results.Errors {
if result.IsExternal {
externalErrors = append(externalErrors, result)
} else {
internalErrors = append(internalErrors, result)
}
}
// Print internal errors first if we have any
if len(internalErrors) > 0 {
fmt.Fprintln(writer, "Errors found:")
for _, result := range internalErrors {
status := fmt.Sprintf("%d", result.Status)
if result.Status == 0 {
status = "ERR"
}
fmt.Fprintf(writer, "%-6s (%-10s) %s [from: %s]\n",
red(status),
yellow(result.Type),
result.URL,
result.SourceURL,
)
}
}
// Print external errors if we have any
if len(externalErrors) > 0 {
if len(internalErrors) > 0 {
fmt.Fprintln(writer, "")
}
fmt.Fprintln(writer, "External Errors:")
fmt.Fprintln(writer, strings.Repeat("-", 80))
fmt.Fprintf(writer, "%-6s | %-10s | %s | %s\n", "Status", "Type", "URL", "Source")
fmt.Fprintln(writer, strings.Repeat("-", 80))
for _, result := range externalErrors {
status := fmt.Sprintf("%d", result.Status)
if result.Status == 0 {
status = "ERR"
}
fmt.Fprintf(writer, "%-6s | %-10s | %s | %s\n",
red(status),
cyan(result.Type),
result.URL,
result.SourceURL,
)
}
}
return nil
}
// JSONReporter generates a JSON report
type JSONReporter struct{}
// Generate generates a JSON report
func (r *JSONReporter) Generate(results *scraper.Results, writer io.Writer) error {
return json.NewEncoder(writer).Encode(results)
}
// CSVReporter generates a CSV report
type CSVReporter struct{}
// Generate generates a CSV report
func (r *CSVReporter) Generate(results *scraper.Results, writer io.Writer) error {
csvWriter := csv.NewWriter(writer)
defer csvWriter.Flush()
// Write header
if err := csvWriter.Write([]string{"Status", "Type", "URL", "Source URL", "Error"}); err != nil {
return err
}
// Write errors
for _, result := range results.Errors {
status := fmt.Sprintf("%d", result.Status)
if result.Status == 0 {
status = "ERROR"
}
if err := csvWriter.Write([]string{
status,
result.Type,
result.URL,
result.SourceURL,
result.Error,
}); err != nil {
return err
}
}
return nil
}
// Helper function to truncate strings
func truncate(s string, maxLen int) string {
if len(s) <= maxLen {
return s
}
return s[:maxLen-3] + "..."
}

206
pkg/reporter/reporter_test.go Normal file
View file

@ -0,0 +1,206 @@
package reporter
import (
"bytes"
"encoding/json"
"strings"
"testing"
"git.nakama.town/fmartingr/dharma/pkg/scraper"
)
func TestNew(t *testing.T) {
tests := []struct {
name string
format string
wantErr bool
}{
{
name: "Pretty format",
format: "pretty",
wantErr: false,
},
{
name: "JSON format",
format: "json",
wantErr: false,
},
{
name: "CSV format",
format: "csv",
wantErr: false,
},
{
name: "Unsupported format",
format: "xml",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := New(tt.format)
if (err != nil) != tt.wantErr {
t.Errorf("New() error = %v, wantErr %v", err, tt.wantErr)
return
}
if !tt.wantErr && got == nil {
t.Errorf("New() = nil, want non-nil")
}
})
}
}
func TestJSONReporter_Generate(t *testing.T) {
// Create test results
results := &scraper.Results{
BaseURL: "https://example.com",
Errors: []scraper.Result{
{
URL: "https://example.com/error",
SourceURL: "https://example.com",
Status: 404,
Error: "HTTP Error: 404 Not Found",
Type: "link",
},
},
Successes: []scraper.Result{
{
URL: "https://example.com/success",
SourceURL: "https://example.com",
Status: 200,
Type: "link",
},
},
Total: 2,
}
// Create reporter and buffer
reporter := &JSONReporter{}
buf := &bytes.Buffer{}
// Generate report
if err := reporter.Generate(results, buf); err != nil {
t.Fatalf("Generate() error = %v", err)
}
// Parse output
var output scraper.Results
if err := json.Unmarshal(buf.Bytes(), &output); err != nil {
t.Fatalf("Failed to parse JSON: %v", err)
}
// Verify output
if output.BaseURL != results.BaseURL {
t.Errorf("BaseURL = %v, want %v", output.BaseURL, results.BaseURL)
}
if len(output.Errors) != len(results.Errors) {
t.Errorf("Errors count = %v, want %v", len(output.Errors), len(results.Errors))
}
if len(output.Successes) != len(results.Successes) {
t.Errorf("Successes count = %v, want %v", len(output.Successes), len(results.Successes))
}
if output.Total != results.Total {
t.Errorf("Total = %v, want %v", output.Total, results.Total)
}
}
func TestCSVReporter_Generate(t *testing.T) {
// Create test results
results := &scraper.Results{
BaseURL: "https://example.com",
Errors: []scraper.Result{
{
URL: "https://example.com/error",
SourceURL: "https://example.com",
Status: 404,
Error: "HTTP Error: 404 Not Found",
Type: "link",
},
},
Successes: []scraper.Result{},
Total: 1,
}
// Create reporter and buffer
reporter := &CSVReporter{}
buf := &bytes.Buffer{}
// Generate report
if err := reporter.Generate(results, buf); err != nil {
t.Fatalf("Generate() error = %v", err)
}
// Verify output
lines := strings.Split(strings.TrimSpace(buf.String()), "\n")
if len(lines) != 2 { // Header + 1 error
t.Errorf("Expected 2 lines, got %d", len(lines))
}
// Check header
expectedHeader := "Status,Type,URL,Source URL,Error"
if lines[0] != expectedHeader {
t.Errorf("Header = %v, want %v", lines[0], expectedHeader)
}
}
func TestPrettyReporter_Generate(t *testing.T) {
// Test with errors
results := &scraper.Results{
BaseURL: "https://example.com",
Errors: []scraper.Result{
{
URL: "https://example.com/error",
SourceURL: "https://example.com",
Status: 404,
Error: "HTTP Error: 404 Not Found",
Type: "link",
},
},
Successes: []scraper.Result{
{
URL: "https://example.com/success",
SourceURL: "https://example.com",
Status: 200,
Type: "link",
},
},
Total: 2,
}
// Create reporter and buffer
reporter := &PrettyReporter{}
buf := &bytes.Buffer{}
// Generate report
if err := reporter.Generate(results, buf); err != nil {
t.Fatalf("Generate() error = %v", err)
}
// Check that output contains key sections
output := buf.String()
if !strings.Contains(output, "Website scan report for") {
t.Error("Output doesn't contain report title")
}
if !strings.Contains(output, "Internal Errors:") {
t.Error("Output doesn't contain errors section")
}
// Test with no errors
results = &scraper.Results{
BaseURL: "https://example.com",
Errors: []scraper.Result{},
Successes: []scraper.Result{},
Total: 0,
}
buf = &bytes.Buffer{}
if err := reporter.Generate(results, buf); err != nil {
t.Fatalf("Generate() error = %v", err)
}
output = buf.String()
if !strings.Contains(output, "No errors found") {
t.Error("Output doesn't contain 'No errors found' message")
}
}

669
pkg/scraper/scraper.go Normal file
View file

@ -0,0 +1,669 @@
package scraper
import (
"bufio"
"fmt"
"net/http"
"net/url"
"regexp"
"strings"
"sync"
"time"
"github.com/PuerkitoBio/goquery"
)
var (
urlRegexp = regexp.MustCompile(`url\(['"]?([^'")]+)['"]?\)`)
importRegexp = regexp.MustCompile(`@import\s+['"]([^'"]+)['"]`)
)
// Result represents a URL check result
type Result struct {
URL string `json:"url"`
SourceURL string `json:"source_url,omitempty"`
Status int `json:"status"`
Error string `json:"error,omitempty"`
Type string `json:"type"` // link, image, script, stylesheet, css-import
IsExternal bool `json:"is_external"`
}
// Results is a collection of Result
type Results struct {
BaseURL string `json:"base_url"`
Errors []Result `json:"errors"`
Successes []Result `json:"successes"`
Total int `json:"total"`
}
// QueueItem represents a URL to be processed along with its source
type QueueItem struct {
URL string
SourceURL string
Depth int
}
// Scraper handles website crawling and link checking
type Scraper struct {
client *http.Client
concurrency int
depth int
verbose bool
internalOnly bool
visitedURLs map[string]bool // URLs visited for crawling
checkedURLs map[string]Result // URLs already checked to avoid duplicate requests
mu sync.Mutex
}
// Option is a function option for the Scraper
type Option func(*Scraper)
// WithConcurrency sets the concurrency level
func WithConcurrency(concurrency int) Option {
return func(s *Scraper) {
s.concurrency = concurrency
}
}
// WithDepth sets the maximum crawling depth
func WithDepth(depth int) Option {
return func(s *Scraper) {
s.depth = depth
}
}
// WithTimeout sets the timeout for HTTP requests
func WithTimeout(timeoutSec int) Option {
return func(s *Scraper) {
s.client.Timeout = time.Duration(timeoutSec) * time.Second
}
}
// WithVerbose enables verbose output
func WithVerbose(verbose bool) Option {
return func(s *Scraper) {
s.verbose = verbose
}
}
// WithInternalOnly sets whether to only check internal links
func WithInternalOnly(internalOnly bool) Option {
return func(s *Scraper) {
s.internalOnly = internalOnly
}
}
// New creates a new Scraper with the given options
func New(options ...Option) *Scraper {
s := &Scraper{
client: &http.Client{
Timeout: 10 * time.Second,
CheckRedirect: func(req *http.Request, via []*http.Request) error {
if len(via) >= 10 {
return fmt.Errorf("too many redirects")
}
return nil
},
},
concurrency: 10,
depth: 3,
visitedURLs: make(map[string]bool),
checkedURLs: make(map[string]Result),
}
for _, option := range options {
option(s)
}
return s
}
// Scan starts the website crawling process
func (s *Scraper) Scan(baseURL string) (*Results, error) {
parsedURL, err := url.Parse(baseURL)
if err != nil {
return nil, fmt.Errorf("invalid URL: %w", err)
}
// Ensure the base URL has a scheme
if parsedURL.Scheme == "" {
parsedURL.Scheme = "https"
baseURL = parsedURL.String()
}
// Store the base hostname for distinguishing internal vs external links
baseHostname := parsedURL.Hostname()
results := &Results{
BaseURL: baseURL,
}
// Create a waitgroup to track active workers
var wg sync.WaitGroup
// Create a channel to communicate URLs to process
queue := make(chan QueueItem, 1000)
// Create a channel to track active URL processing
activeCount := make(chan int, 1)
activeCount <- 1 // Start with 1 active URL (the base URL)
// Start worker pool
for range s.concurrency {
wg.Add(1)
go func() {
defer wg.Done()
for item := range queue {
s.processURL(item.URL, item.SourceURL, baseHostname, item.Depth, queue, results, activeCount)
}
}()
}
// Initial URL to process - the source is itself for the initial URL
queue <- QueueItem{
URL: baseURL,
SourceURL: baseURL,
Depth: 0,
}
// Monitor active count - when it reaches 0, we're done
go func() {
for {
count := <-activeCount
if count <= 0 {
close(queue)
return
}
activeCount <- count
}
}()
// Wait for workers to finish
wg.Wait()
results.Total = len(results.Errors) + len(results.Successes)
return results, nil
}
// processURL processes a single URL
func (s *Scraper) processURL(currentURL, sourceURL string, baseHostname string, depth int, queue chan<- QueueItem, results *Results, activeCount chan int) {
// Decrement active count when done
defer func() {
count := <-activeCount
activeCount <- count - 1
}()
// Check if we've already visited this URL (for crawling) or exceeded max depth
s.mu.Lock()
if s.visitedURLs[currentURL] || depth > s.depth {
s.mu.Unlock()
return
}
s.visitedURLs[currentURL] = true
// If we've already checked this URL's status, reuse the result
if result, exists := s.checkedURLs[currentURL]; exists {
// Always use the provided source URL
result.SourceURL = sourceURL
s.mu.Unlock()
s.addResult(results, result)
// We still need to parse HTML/CSS content even if we've checked the URL before
// But only if it was successful
if result.Error == "" && result.Status < 400 {
// Continue with content parsing...
} else {
return
}
} else {
s.mu.Unlock()
}
if s.verbose {
fmt.Printf("Checking: %s (depth: %d) [source: %s]\n", currentURL, depth, sourceURL)
}
// Parse the current URL
currentParsed, err := url.Parse(currentURL)
if err != nil {
result := Result{
URL: currentURL,
SourceURL: sourceURL,
Error: fmt.Sprintf("Invalid URL: %v", err),
Type: "link",
IsExternal: false,
}
s.mu.Lock()
s.checkedURLs[currentURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
// Determine if the URL is internal or external
isExternal := currentParsed.Hostname() != baseHostname && currentParsed.Hostname() != ""
// Skip external links processing if internalOnly is set
if isExternal && s.internalOnly {
return
}
// Process external links differently from internal links
if isExternal {
s.checkExternalURL(currentURL, sourceURL, results)
return
}
// Internal URL, check and crawl
resp, err := s.client.Get(currentURL)
if err != nil {
result := Result{
URL: currentURL,
SourceURL: sourceURL,
Error: err.Error(),
Type: "link",
IsExternal: isExternal,
}
s.mu.Lock()
s.checkedURLs[currentURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
defer resp.Body.Close()
// Add the result
var result Result
if resp.StatusCode >= 400 {
result = Result{
URL: currentURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Error: fmt.Sprintf("HTTP Error: %s", resp.Status),
Type: "link",
IsExternal: isExternal,
}
s.mu.Lock()
s.checkedURLs[currentURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
} else {
result = Result{
URL: currentURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Type: "link",
IsExternal: isExternal,
}
s.mu.Lock()
s.checkedURLs[currentURL] = result
s.mu.Unlock()
s.addResult(results, result)
}
// Only parse HTML and CSS from internal links
contentType := resp.Header.Get("Content-Type")
if strings.Contains(contentType, "text/html") {
// Use the base hostname to create a base URL for this site
baseURL := ""
if currentParsed.Scheme != "" && currentParsed.Host != "" {
baseURL = fmt.Sprintf("%s://%s", currentParsed.Scheme, currentParsed.Host)
}
foundURLs := s.parseHTML(currentURL, resp, baseURL, baseHostname, depth+1, results)
// Add all found URLs to the queue and increment active count
if len(foundURLs) > 0 {
count := <-activeCount
count += len(foundURLs)
activeCount <- count
for _, url := range foundURLs {
queue <- QueueItem{
URL: url,
SourceURL: currentURL, // The source URL is the current page we're processing
Depth: depth + 1,
}
}
}
} else if strings.Contains(contentType, "text/css") {
// Use the base hostname to create a base URL for this site
baseURL := ""
if currentParsed.Scheme != "" && currentParsed.Host != "" {
baseURL = fmt.Sprintf("%s://%s", currentParsed.Scheme, currentParsed.Host)
}
s.parseCSS(currentURL, resp, baseURL, baseHostname, results)
}
}
// parseHTML extracts links and other resources from HTML
func (s *Scraper) parseHTML(sourceURL string, resp *http.Response, baseURL, baseHostname string, _ int, results *Results) []string {
foundURLs := []string{}
doc, err := goquery.NewDocumentFromReader(resp.Body)
if err != nil {
s.addResult(results, Result{
URL: sourceURL,
SourceURL: sourceURL, // Use self as source for error
Error: fmt.Sprintf("Failed to parse HTML: %v", err),
Status: resp.StatusCode,
Type: "html",
IsExternal: false,
})
return foundURLs
}
// Process links (a href)
doc.Find("a").Each(func(i int, sel *goquery.Selection) {
if href, exists := sel.Attr("href"); exists {
targetURL := s.resolveURL(href, sourceURL)
if targetURL != "" {
linkParsed, err := url.Parse(targetURL)
if err == nil {
isExternal := linkParsed.Hostname() != baseHostname && linkParsed.Hostname() != ""
// Only add internal links to the crawl queue
if !isExternal {
foundURLs = append(foundURLs, targetURL)
} else if !s.internalOnly {
// Check external links only if internalOnly is false
s.checkExternalURL(targetURL, sourceURL, results)
}
}
}
}
})
// Process images
doc.Find("img").Each(func(i int, sel *goquery.Selection) {
if src, exists := sel.Attr("src"); exists {
targetURL := s.resolveURL(src, sourceURL)
if targetURL != "" {
s.checkResource(targetURL, sourceURL, "image", baseHostname, results)
}
}
})
// Process stylesheets
doc.Find("link[rel='stylesheet']").Each(func(i int, sel *goquery.Selection) {
if href, exists := sel.Attr("href"); exists {
targetURL := s.resolveURL(href, sourceURL)
if targetURL != "" {
s.checkResource(targetURL, sourceURL, "stylesheet", baseHostname, results)
}
}
})
// Process scripts
doc.Find("script").Each(func(i int, sel *goquery.Selection) {
if src, exists := sel.Attr("src"); exists {
targetURL := s.resolveURL(src, sourceURL)
if targetURL != "" {
s.checkResource(targetURL, sourceURL, "script", baseHostname, results)
}
}
})
return foundURLs
}
// parseCSS extracts URLs from CSS content
func (s *Scraper) parseCSS(sourceURL string, resp *http.Response, baseURL, baseHostname string, results *Results) {
// Simple regex-based parsing for CSS imports and url() references
// This is a simplified approach; a proper CSS parser would be better
// for production use
scanner := bufio.NewScanner(resp.Body)
for scanner.Scan() {
line := scanner.Text()
// Look for url() references
urlMatches := urlRegexp.FindAllStringSubmatch(line, -1)
for _, match := range urlMatches {
if len(match) > 1 {
// Remove quotes if present
urlValue := strings.Trim(match[1], "'\"")
targetURL := s.resolveURL(urlValue, sourceURL)
if targetURL != "" {
s.checkResource(targetURL, sourceURL, "css-url", baseHostname, results)
}
}
}
// Look for @import statements
importMatches := importRegexp.FindAllStringSubmatch(line, -1)
for _, match := range importMatches {
if len(match) > 1 {
// Remove quotes if present
urlValue := strings.Trim(match[1], "'\"")
targetURL := s.resolveURL(urlValue, sourceURL)
if targetURL != "" {
s.checkResource(targetURL, sourceURL, "css-import", baseHostname, results)
}
}
}
}
}
// resolveURL resolves a relative URL against a base URL
func (s *Scraper) resolveURL(href, sourceURL string) string {
// Skip empty URLs, anchors, and javascript
if href == "" || strings.HasPrefix(href, "#") || strings.HasPrefix(href, "javascript:") {
return ""
}
// Skip non-HTTP protocols like mailto:, tel:, etc.
if strings.HasPrefix(href, "mailto:") ||
strings.HasPrefix(href, "tel:") ||
strings.HasPrefix(href, "sms:") ||
strings.HasPrefix(href, "ftp:") ||
strings.HasPrefix(href, "file:") {
return ""
}
sourceParsed, err := url.Parse(sourceURL)
if err != nil {
return ""
}
targetParsed, err := url.Parse(href)
if err != nil {
return ""
}
// If the scheme is not HTTP/HTTPS, skip it
if targetParsed.Scheme != "" &&
targetParsed.Scheme != "http" &&
targetParsed.Scheme != "https" {
return ""
}
resolvedURL := sourceParsed.ResolveReference(targetParsed).String()
return resolvedURL
}
// checkExternalURL performs a HEAD request to check external URLs
func (s *Scraper) checkExternalURL(targetURL, sourceURL string, results *Results) {
// Skip external links if internalOnly is set
if s.internalOnly {
return
}
// Check if URL was already checked
s.mu.Lock()
if result, exists := s.checkedURLs[targetURL]; exists {
// Add the existing result with the current source URL
result.SourceURL = sourceURL
s.mu.Unlock()
s.addResult(results, result)
return
}
s.mu.Unlock()
req, err := http.NewRequest("HEAD", targetURL, nil)
if err != nil {
result := Result{
URL: targetURL,
SourceURL: sourceURL,
Error: fmt.Sprintf("Invalid URL: %v", err),
Type: "external-link",
IsExternal: true,
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
resp, err := s.client.Do(req)
if err != nil {
result := Result{
URL: targetURL,
SourceURL: sourceURL,
Error: err.Error(),
Type: "external-link",
IsExternal: true,
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
defer resp.Body.Close()
var result Result
if resp.StatusCode >= 400 {
result = Result{
URL: targetURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Error: fmt.Sprintf("HTTP Error: %s", resp.Status),
Type: "external-link",
IsExternal: true,
}
} else {
result = Result{
URL: targetURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Type: "external-link",
IsExternal: true,
}
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
}
// checkResource checks if a resource URL is accessible
func (s *Scraper) checkResource(targetURL, sourceURL, resourceType, baseHostname string, results *Results) {
// Parse the target URL to determine if it's internal or external
targetParsed, err := url.Parse(targetURL)
if err != nil {
result := Result{
URL: targetURL,
SourceURL: sourceURL,
Error: fmt.Sprintf("Invalid URL: %v", err),
Type: resourceType,
IsExternal: false,
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
isExternal := targetParsed.Hostname() != baseHostname && targetParsed.Hostname() != ""
// Skip external resources if internalOnly is set
if isExternal && s.internalOnly {
return
}
// Check if URL was already checked
s.mu.Lock()
if result, exists := s.checkedURLs[targetURL]; exists {
// Update with current source and type if needed
result.SourceURL = sourceURL
result.Type = resourceType
s.mu.Unlock()
s.addResult(results, result)
return
}
s.mu.Unlock()
req, err := http.NewRequest("HEAD", targetURL, nil)
if err != nil {
result := Result{
URL: targetURL,
SourceURL: sourceURL,
Error: fmt.Sprintf("Invalid URL: %v", err),
Type: resourceType,
IsExternal: isExternal,
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
resp, err := s.client.Do(req)
if err != nil {
result := Result{
URL: targetURL,
SourceURL: sourceURL,
Error: err.Error(),
Type: resourceType,
IsExternal: isExternal,
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
return
}
defer resp.Body.Close()
var result Result
if resp.StatusCode >= 400 {
result = Result{
URL: targetURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Error: fmt.Sprintf("HTTP Error: %s", resp.Status),
Type: resourceType,
IsExternal: isExternal,
}
} else {
result = Result{
URL: targetURL,
SourceURL: sourceURL,
Status: resp.StatusCode,
Type: resourceType,
IsExternal: isExternal,
}
}
s.mu.Lock()
s.checkedURLs[targetURL] = result
s.mu.Unlock()
s.addResult(results, result)
}
// addResult adds a result to the appropriate list
func (s *Scraper) addResult(results *Results, result Result) {
s.mu.Lock()
defer s.mu.Unlock()
if result.Error != "" {
results.Errors = append(results.Errors, result)
} else {
results.Successes = append(results.Successes, result)
}
}

163
pkg/scraper/scraper_test.go Normal file
View file

@ -0,0 +1,163 @@
package scraper
import (
"net/http"
"net/http/httptest"
"net/url"
"testing"
)
func TestResolveURL(t *testing.T) {
s := &Scraper{}
tests := []struct {
name string
href string
sourceURL string
baseURL string
wantResult string
}{
{
name: "Absolute URL",
href: "https://example.com/page.html",
sourceURL: "https://example.org/index.html",
baseURL: "https://example.org/",
wantResult: "https://example.com/page.html",
},
{
name: "Relative URL",
href: "page.html",
sourceURL: "https://example.org/index.html",
baseURL: "https://example.org/",
wantResult: "https://example.org/page.html",
},
{
name: "Anchor link",
href: "#section",
sourceURL: "https://example.org/index.html",
baseURL: "https://example.org/",
wantResult: "",
},
{
name: "JavaScript link",
href: "javascript:void(0)",
sourceURL: "https://example.org/index.html",
baseURL: "https://example.org/",
wantResult: "",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := s.resolveURL(tt.href, tt.sourceURL)
if got != tt.wantResult {
t.Errorf("resolveURL() = %v, want %v", got, tt.wantResult)
}
})
}
}
func TestNew(t *testing.T) {
s := New(
WithConcurrency(20),
WithDepth(5),
WithTimeout(30),
WithVerbose(true),
)
if s.concurrency != 20 {
t.Errorf("Expected concurrency to be 20, got %d", s.concurrency)
}
if s.depth != 5 {
t.Errorf("Expected depth to be 5, got %d", s.depth)
}
if s.client.Timeout != 30*1000*1000*1000 { // 30 seconds in nanoseconds
t.Errorf("Expected timeout to be 30s, got %v", s.client.Timeout)
}
if !s.verbose {
t.Errorf("Expected verbose to be true")
}
}
func TestAddResult(t *testing.T) {
s := &Scraper{}
results := &Results{}
// Add an error result
errorResult := Result{
URL: "https://example.com/error",
Error: "Test error",
Type: "link",
}
s.addResult(results, errorResult)
if len(results.Errors) != 1 {
t.Errorf("Expected 1 error, got %d", len(results.Errors))
}
// Add a success result
successResult := Result{
URL: "https://example.com/success",
Status: 200,
Type: "link",
}
s.addResult(results, successResult)
if len(results.Successes) != 1 {
t.Errorf("Expected 1 success, got %d", len(results.Successes))
}
}
func TestProcessURL(t *testing.T) {
// Create a test server
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/html")
if _, err := w.Write([]byte(`
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="/style.css">
<script src="/script.js"></script>
</head>
<body>
<a href="/page1.html">Page 1</a>
<a href="https://example.com">External</a>
<img src="/image.jpg">
</body>
</html>
`)); err != nil {
t.Fatalf("Failed to write response: %v", err)
}
}))
defer server.Close()
s := New(WithDepth(1), WithConcurrency(1))
results := &Results{}
// Create a channel for QueueItems instead of strings
queue := make(chan QueueItem, 10)
// Create active count channel
activeCount := make(chan int, 1)
activeCount <- 1 // Start with one active URL
// Parse the server URL to get the hostname
serverURL, _ := url.Parse(server.URL)
baseHostname := serverURL.Hostname()
// Process the URL with the updated signature
s.processURL(server.URL, server.URL, baseHostname, 0, queue, results, activeCount)
// Check that we found at least one success (the main page)
if len(results.Successes) < 1 {
t.Errorf("Expected at least 1 success, got %d", len(results.Successes))
}
// Check that we queued some URLs for processing
if len(queue) < 1 {
t.Errorf("Expected at least 1 URL in queue, got %d", len(queue))
}
}

206
pkg/scraper/testsite_test.go Normal file
View file

@ -0,0 +1,206 @@
package scraper
import (
"strings"
"testing"
"git.nakama.town/fmartingr/dharma/pkg/testutil"
)
func TestTestsiteIntegration(t *testing.T) {
// Skip if running short tests
if testing.Short() {
t.Skip("Skipping integration test in short mode")
}
// Start the testsite server
serverURL, cleanup, err := testutil.StartTestsiteServer()
if err != nil {
t.Fatalf("Failed to start test server: %v", err)
}
defer cleanup()
// Create a new scraper with default settings
s := New(
WithConcurrency(2),
WithDepth(3),
WithTimeout(5),
WithVerbose(false),
WithInternalOnly(true),
)
// Run the scraper
results, err := s.Scan(serverURL)
if err != nil {
t.Fatalf("Scraper.Scan failed: %v", err)
}
// Verify we have results
if results == nil {
t.Fatal("Expected results but got nil")
}
// Check that we have the correct base URL
if results.BaseURL != serverURL {
t.Errorf("Expected BaseURL to be %s, got %s", serverURL, results.BaseURL)
}
// Test cases for specific URLs that should be found
expectedURLs := map[string]bool{
"/found.html": true,
"/not_found.html": false,
"/rel/index.html": true,
"/rel/relfound.html": true,
"/static/style.css": true,
"/static/script.js": true,
}
// Check for expected URLs in the results
for urlPath, shouldExist := range expectedURLs {
fullURL := serverURL + urlPath
found := false
// Look in both successes and errors
for _, result := range results.Successes {
if result.URL == fullURL {
found = true
if !shouldExist {
t.Errorf("URL %s should not exist but was found in successes", urlPath)
}
break
}
}
if !found && shouldExist {
// If not found in successes, check if it's in errors
for _, result := range results.Errors {
if result.URL == fullURL {
found = true
t.Errorf("URL %s should exist but was found in errors", urlPath)
break
}
}
if !found {
t.Errorf("Expected URL %s was not found in results", urlPath)
}
}
}
// Check that not_found.html is in errors
notFoundURL := serverURL + "/not_found.html"
foundInErrors := false
for _, result := range results.Errors {
if result.URL == notFoundURL {
foundInErrors = true
break
}
}
if !foundInErrors {
t.Errorf("Expected %s to be in errors but it wasn't", notFoundURL)
}
// Verify relative links in the rel directory
relNotFoundURL := serverURL + "/rel/rel_not_found.html"
foundRelNotFound := false
for _, result := range results.Errors {
if result.URL == relNotFoundURL {
foundRelNotFound = true
break
}
}
if !foundRelNotFound {
t.Errorf("Expected %s to be in errors but it wasn't", relNotFoundURL)
}
// Check for missing image
missingImageURL := serverURL + "/rel/image-404.jpg"
foundMissingImage := false
for _, result := range results.Errors {
if result.URL == missingImageURL {
foundMissingImage = true
break
}
}
if !foundMissingImage {
t.Errorf("Expected %s to be in errors but it wasn't", missingImageURL)
}
// Check for external links
externalLinkCount := 0
for _, result := range results.Successes {
if strings.Contains(result.URL, "fmartingr.com") {
externalLinkCount++
}
}
if externalLinkCount != 0 {
t.Errorf("Found %d external links but should be 0 with internalOnly=true", externalLinkCount)
}
// Verify total count
expectedTotal := len(results.Successes) + len(results.Errors)
if results.Total != expectedTotal {
t.Errorf("Expected Total to be %d, got %d", expectedTotal, results.Total)
}
}
func TestTestsiteWithExternalLinks(t *testing.T) {
// Skip if running short tests
if testing.Short() {
t.Skip("Skipping integration test in short mode")
}
// Start the testsite server
serverURL, cleanup, err := testutil.StartTestsiteServer()
if err != nil {
t.Fatalf("Failed to start test server: %v", err)
}
defer cleanup()
// Create a new scraper with external links allowed
s := New(
WithConcurrency(2),
WithDepth(1), // Lower depth for external links test
WithTimeout(5),
WithVerbose(false),
WithInternalOnly(false), // Allow external links
)
// Run the scraper
results, err := s.Scan(serverURL)
if err != nil {
t.Fatalf("Scraper.Scan failed: %v", err)
}
// Check for external links - we should find at least one external link
foundExternalLinks := false
brokenExternalLinks := false
for _, result := range results.Successes {
if result.IsExternal && strings.Contains(result.URL, "fmartingr.com") {
foundExternalLinks = true
break
}
}
for _, result := range results.Errors {
if result.IsExternal && strings.Contains(result.URL, "e3H7iaV685rbH7R5lBNxgpietP7JTnMeknmi9SNAEUT4XSiH2sET6ixAcjhy4CAi") {
brokenExternalLinks = true
break
}
}
// We don't actually hit external URLs in tests, so we can't assert on them,
// but we can check that they're properly identified
if !foundExternalLinks {
t.Log("No successful external links found in test - this is expected in CI/isolated test environments")
}
if !brokenExternalLinks {
t.Log("No broken external links found in test - this is expected in CI/isolated test environments")
}
}

79
pkg/testutil/testserver.go Normal file
View file

@ -0,0 +1,79 @@
package testutil
import (
"fmt"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
)
// StartTestsiteServer starts an HTTP server for the testsite directory
// and returns the server URL and a cleanup function
func StartTestsiteServer() (string, func(), error) {
// Determine the absolute path to the testsite directory
wd, err := os.Getwd()
if err != nil {
return "", nil, fmt.Errorf("failed to get working directory: %v", err)
}
// Navigate up to find the project root
// This assumes the function is called from somewhere within the project
projectRoot := wd
for {
if _, err := os.Stat(filepath.Join(projectRoot, "testsite")); err == nil {
break // Found the testsite directory
}
parent := filepath.Dir(projectRoot)
if parent == projectRoot {
return "", nil, fmt.Errorf("testsite directory not found")
}
projectRoot = parent
}
testsitePath := filepath.Join(projectRoot, "testsite")
if _, err := os.Stat(testsitePath); err != nil {
return "", nil, fmt.Errorf("testsite directory not found: %v", err)
}
// Create a file server for the testsite directory
fileServer := http.FileServer(http.Dir(testsitePath))
// Create a test server to serve the testsite files
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fileServer.ServeHTTP(w, r)
}))
// Return the server URL and a cleanup function
return server.URL, server.Close, nil
}
// GetTestsitePath returns the absolute path to the testsite directory
func GetTestsitePath() (string, error) {
// Determine the absolute path to the testsite directory
wd, err := os.Getwd()
if err != nil {
return "", fmt.Errorf("failed to get working directory: %v", err)
}
// Navigate up to find the project root
// This assumes the function is called from somewhere within the project
projectRoot := wd
for {
if _, err := os.Stat(filepath.Join(projectRoot, "testsite")); err == nil {
break // Found the testsite directory
}
parent := filepath.Dir(projectRoot)
if parent == projectRoot {
return "", fmt.Errorf("testsite directory not found")
}
projectRoot = parent
}
testsitePath := filepath.Join(projectRoot, "testsite")
if _, err := os.Stat(testsitePath); err != nil {
return "", fmt.Errorf("testsite directory not found: %v", err)
}
return testsitePath, nil
}

74
scripts/test_testsite.sh Executable file
View file

@ -0,0 +1,74 @@
#!/bin/bash
set -e
# Colors for output
GREEN='\033[0;32m'
RED='\033[0;31m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color
echo -e "${BLUE}Dharma Testsite Test Runner${NC}"
echo -e "${BLUE}---------------------------${NC}"
echo
# Ensure we're in the project root
cd "$(dirname "$0")/.."
# Build dharma binary for testing
echo -e "${BLUE}Building dharma binary...${NC}"
go build -o dharma_test ./cmd/dharma
# Make the script executable
chmod +x ./dharma_test
# Start a simple HTTP server for the testsite
echo -e "${BLUE}Starting testsite server...${NC}"
cd testsite
SERVER_PID=""
# Function to clean up server and binary
cleanup() {
echo -e "${BLUE}Cleaning up...${NC}"
if [ ! -z "$SERVER_PID" ]; then
echo "Stopping server (PID: $SERVER_PID)..."
kill $SERVER_PID 2>/dev/null || true
fi
cd ..
[ -f ./dharma_test ] && rm ./dharma_test
echo -e "${GREEN}Cleanup complete.${NC}"
}
# Set up cleanup on script exit
trap cleanup EXIT
# Start the server in the background
python3 -m http.server 8765 &
SERVER_PID=$!
echo -e "${GREEN}Testsite server started on http://localhost:8765${NC}"
echo
sleep 1
cd ..
# Run dharma against the testsite
echo -e "${BLUE}Running dharma against testsite...${NC}"
./dharma_test http://localhost:8765
echo
echo -e "${BLUE}Testing different output formats...${NC}"
echo -e "${BLUE}JSON format:${NC}"
./dharma_test --format json http://localhost:8765 | head -n 10
echo "..."
echo -e "${BLUE}CSV format:${NC}"
./dharma_test --format csv http://localhost:8765 | head -n 5
echo "..."
echo -e "${BLUE}Internal links only:${NC}"
./dharma_test --internal-only http://localhost:8765 | grep -m 3 "found.html"
echo "..."
echo
echo -e "${GREEN}All tests completed successfully!${NC}"

64
testsite/README.md Normal file
View file

@ -0,0 +1,64 @@
# Dharma Test Site
This directory contains a small test site used for testing the Dharma link checker tool.
## Structure
- `index.html` - Main page with various links (some broken)
- `found.html` - A page that exists
- `rel/` - Directory containing a subpage with relative links
- `index.html` - Page with relative links
- `relfound.html` - Another page that exists
- `image.jpg` - An image file that exists
- `static/` - Directory for static assets
- `style.css` - CSS file
- `script.js` - JavaScript file
## Test Cases
This test site is designed to test:
1. Working links (internal and external)
2. 404 links (missing pages)
3. Relative links in subdirectories
4. Static assets (CSS, JS, images)
5. External links (both working and broken)
## Test Suite
The test suite consists of several components:
1. **Scraper Tests** (`pkg/scraper/testsite_test.go`): Tests the core scraper functionality against the testsite.
2. **CLI Tests** (`pkg/cli/testsite_test.go`): Tests the CLI interface with the testsite.
3. **Integration Tests** (`testsite_test.go`): Full end-to-end tests using the actual binary.
4. **Test Utility** (`pkg/testutil/testserver.go`): Helper functions for testing with the testsite.
5. **Test Script** (`scripts/test_testsite.sh`): Shell script for manual testing of the tool against the testsite.
## Usage
The test site is used by the automated test suite to verify that the Dharma link checker correctly identifies broken and working links. The test suite will:
1. Start a local HTTP server for this test site
2. Run the Dharma tool against it
3. Verify that the tool correctly identifies the broken and working links
To run the tests:
```bash
# Run all tests
go test -v ./...
# Run tests excluding integration tests
go test -v -short ./...
# Run testsite tests specifically
make test-testsite
```
## Adding New Test Cases
To add new test cases:
1. Add new HTML files or assets to the testsite directory
2. Update the test expectations in the test files
3. Run the tests to verify they work with the new content

1
testsite/found.html Normal file
View file

@ -0,0 +1 @@
found

23
testsite/index.html Normal file
View file

@ -0,0 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<link rel="stylesheet" href="/static/style.css">
</head>
<body>
<a href="/found.html">found.html</a> <br>
<a href="/not_found.html">not_found.html</a> <br>
<a href="/rel/index.html">rel.html</a>
<a href="https://fmartingr.com">External link (ok)</a> <br>
<a href="http://fmartingr.com">External link (ok - http redir)</a> <br>
<a href="https://www.e3H7iaV685rbH7R5lBNxgpietP7JTnMeknmi9SNAEUT4XSiH2sET6ixAcjhy4CAi.com">External link (nack)</a>
<br>
<script src="/static/script.js" type="text/javascript"></script>
</body>
</html>

0
testsite/rel/image.jpg Normal file
View file

22
testsite/rel/index.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<link rel="stylesheet" href="./style.css">
</head>
<body>
<a href="./relfound.html">found.html</a> <br>
<a href="./rel_not_found.html">not_found.html</a> <br>
<img src="./image.jpg"> <br>
<img src="./image-404.jpg"> <br>
<img src="./e3H7iaV685rbH7R5lBNxgpietP7JTnMeknmi9SNAEUT4XSiH2sET6ixAcjhy4CAi"> <br>
<br>
<script src="/static/script.js" type="text/javascript"></script>
</body>
</html>

1
testsite/rel/relfound.html Normal file
View file

@ -0,0 +1 @@
found

0
testsite/static/script.js Normal file
View file

0
testsite/static/style.css Normal file
View file

115
testsite_test.go Normal file
View file

@ -0,0 +1,115 @@
package main
import (
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"git.nakama.town/fmartingr/dharma/pkg/testutil"
)
// TestFullIntegration runs a full integration test of the tool against testsite
// This test uses the actual binary to verify everything works end-to-end
func TestFullIntegration(t *testing.T) {
// Skip this test if running in CI environment or if it's a short test run
if testing.Short() {
t.Skip("Skipping full integration test in short mode")
}
// Build the binary
buildCmd := exec.Command("go", "build", "-o", "dharma_test", "./cmd/dharma")
if err := buildCmd.Run(); err != nil {
t.Fatalf("Failed to build binary: %v", err)
}
defer os.Remove("dharma_test") // Clean up after test
// Build absolute path to dharma_test binary
wd, err := os.Getwd()
if err != nil {
t.Fatalf("Failed to get working directory: %v", err)
}
dharmaPath := filepath.Join(wd, "dharma_test")
// Start the testsite server
serverURL, cleanup, err := testutil.StartTestsiteServer()
if err != nil {
t.Fatalf("Failed to start test server: %v", err)
}
defer cleanup()
// Test cases for different formats
testCases := []struct {
name string
args []string
expectCode int
expectText string
}{
{
name: "Basic scan",
args: []string{serverURL},
expectCode: 0,
expectText: "not_found.html",
},
{
name: "JSON output",
args: []string{"--format", "json", serverURL},
expectCode: 0,
expectText: `"url"`,
},
{
name: "CSV output",
args: []string{"--format", "csv", serverURL},
expectCode: 0,
expectText: "Status,Type,URL",
},
{
name: "Internal links only",
args: []string{"--internal-only", serverURL},
expectCode: 0,
expectText: "not_found.html",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
// Run the binary
cmd := exec.Command(dharmaPath, tc.args...)
output, err := cmd.CombinedOutput()
// Check exit code
var exitCode int
if err != nil {
if exitError, ok := err.(*exec.ExitError); ok {
exitCode = exitError.ExitCode()
} else {
t.Fatalf("Failed to run binary: %v", err)
}
}
if exitCode != tc.expectCode {
t.Errorf("Expected exit code %d, got %d", tc.expectCode, exitCode)
}
// Check output contains expected text
if tc.expectText != "" && !containsString(string(output), tc.expectText) {
t.Errorf("Expected output to contain %q but didn't.\nOutput:\n%s", tc.expectText, output)
}
// Verify we got some output
if len(output) == 0 {
t.Errorf("Expected output but got none")
}
// Print summary of the results
fmt.Printf("Test %s: Found %d bytes of output\n", tc.name, len(output))
})
}
}
// containsString checks if a string contains another string
func containsString(haystack, needle string) bool {
return strings.Contains(haystack, needle)
}