diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..99f12d2 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "monthly" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..b35ffdb --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,47 @@ +name: build-and-test +on: [push, pull_request] +jobs: + build: + strategy: + matrix: + version: [1.21] + os: [ubuntu-latest, windows-latest, macos-latest] + name: Build + runs-on: ${{ matrix.os }} + steps: + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version: ${{ matrix.version }} + id: go + + - name: checkout + uses: actions/checkout@v4 + + - name: build + run: go build + + - name: test + run: make test + + - name: Update coverage report + uses: ncruces/go-coverage-report@main + with: + report: true + chart: true + amend: true + if: | + matrix.os == 'ubuntu-latest' && + github.event_name == 'push' + continue-on-error: true + + golangci: + name: lint + runs-on: ubuntu-latest + steps: + - uses: actions/setup-go@v5 + with: + go-version: 1.21 + - uses: actions/checkout@v4 + - name: golangci-lint + uses: golangci/golangci-lint-action@v6 diff --git a/.github/workflows/pushimage.yaml b/.github/workflows/pushimage.yaml new file mode 100644 index 0000000..5d41c9f --- /dev/null +++ b/.github/workflows/pushimage.yaml @@ -0,0 +1,34 @@ +name: build-push-image + +on: + push: + tags: + - 'v*' + +jobs: + build-and-push-image: + runs-on: ubuntu-latest + permissions: + packages: write + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Log in to the Container registry + uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 + with: + registry: https://ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build and push Docker image + uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 + with: + push: true + tags: ghcr.io/tlinden/anydb:${{ github.ref_name}} + + - name: Build and push latest Docker image + uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 + with: + push: true + tags: ghcr.io/tlinden/anydb:latest diff --git a/.gitignore b/.gitignore index 3c9923b..2b666ef 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ anydb *.log *.db +coverage.out +*.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/Makefile b/Makefile index 5186d12..fbbf7b9 100644 --- a/Makefile +++ b/Makefile @@ -67,7 +67,6 @@ clean: test: go test -v ./... - bash t/test.sh singletest: @echo "Call like this: ''make singletest TEST=TestPrepareColumns MOD=lib" diff --git a/README.md b/README.md new file mode 100644 index 0000000..2807f0e --- /dev/null +++ b/README.md @@ -0,0 +1,157 @@ +## A personal key value store + +[![Actions](https://github.com/tlinden/anydb/actions/workflows/ci.yaml/badge.svg)](https://github.com/tlinden/anydb/actions) +[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://github.com/tlinden/anydb/blob/master/LICENSE) +[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/anydb)](https://goreportcard.com/report/github.com/tlinden/anydb) + +Anydb is a simple to use commandline tool to store anything you'd +like, even binary files etc. It is a re-implementation of +[skate](https://github.com/charmbracelet/skate) for the following +reasons: + +- it's just fun to do +- anydb uses [bbolt](https://github.com/etcd-io/bbolt) instead of + badger. bbolt has a stable file format, which doesn't change + anymore. The badger file format on the other hand changes very + often, which is not good for a tool intended to be used for many + years. +- more features + +**anydb** can do all the things you can do with skate: + +```shell +# Store something (and sync it to the network) +anydb set kitty meow + +# Fetch something (from the local cache) +anydb get kitty + +# What’s in the store? +anydb list + +# Spaces are fine +anydb set "kitty litter" "smells great" + +# You can store binary data, too +anydb set profile-pic < my-cute-pic.jpg +anydb get profile-pic > here-it-is.jpg + +# Unicode also works, of course +anydb set 猫咪 喵 +anydb get 猫咪 + +# For more info +anydb --help + +# Do creative things with anydb list +anydb set penelope marmalade +anydb set christian tacos +anydb set muesli muesli + +anydb list | xargs -n 2 printf '%s loves %s.\n' +``` + +However, there are more features than just that! + +```shell +# you can assign tags +anydb set foo bar -t note,important + +# and filter for them +anydb list -t important + +# beside tags filtering you can also use regexps for searching +anydb list '[a-z]+\d' + +# anydb also supports a wide output +anydb list -o wide +KEY TAGS SIZE AGE VALUE +blah important 4 B 7 seconds ago haha +foo 3 B 15 seconds ago bar +猫咪 3 B 3 seconds ago 喵 + +# there are shortcuts as well +anydb ls -l +anydb / + +# other outputs are possible as well +anydb list -o json + +# you can backup your database +anydb export -o backup.json + +# and import it somewhere else +anydb import -r backup.json + +# it comes with a manpage builtin +anydb man +``` + +## Installation + +There are multiple ways to install **anydb**: + +- Go to the [latest release page](https://github.com/tlinden/anydb/releases/latest), + locate the binary for your operating system and platform. + + Download it and put it into some directory within your `$PATH` variable. + +- The release page also contains a tarball for every supported platform. Unpack it + to some temporary directory, extract it and execute the following command inside: + ``` + sudo make install + ``` + +- You can also install from source. Issue the following commands in your shell: + ``` + git clone https://github.com/TLINDEN/anydb.git + cd anydb + make + sudo make install + ``` + +If you do not find a binary release for your platform, please don't +hesitate to ask me about it, I'll add it. + +## Documentation + +The documentation is provided as a unix man-page. It will be +automatically installed if you install from source. However, you can +[read the man-page online](https://github.com/TLINDEN/anydb/blob/master/anydb.pod) + +Or if you cloned the repository you can read it this way (perl needs +to be installed though): `perldoc anydb.pod`. + +If you have the binary installed, you can also read the man page with +this command: + + anydb man + +## Getting help + +Although I'm happy to hear from anydb users in private email, that's the +best way for me to forget to do something. + +In order to report a bug, unexpected behavior, feature requests or to +submit a patch, please open an issue on github: +https://github.com/TLINDEN/anydb/issues. + +## Copyright and license + +This software is licensed under the GNU GENERAL PUBLIC LICENSE version 3. + +## Authors + +T.v.Dein + +## Project homepage + +https://github.com/TLINDEN/anydb + +## Copyright and License + +Licensed under the GNU GENERAL PUBLIC LICENSE version 3. + +## Author + +T.v.Dein diff --git a/anydb.1 b/anydb.1 index f120d8e..955aaaa 100644 --- a/anydb.1 +++ b/anydb.1 @@ -133,11 +133,49 @@ .\" ======================================================================== .\" .IX Title "ANYDB 1" -.TH ANYDB 1 "2024-12-16" "1" "User Commands" +.TH ANYDB 1 "2024-12-18" "1" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "anydb" .IX Header "anydb" -\&\s-1FIXME\s0 +anydb \- a personal key value store +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +.Vb 3 +\& Usage: +\& anydb [options] [flags] +\& anydb [command] +\& +\& Available Commands: +\& completion Generate the autocompletion script for the specified shell +\& del Delete key +\& export Export database to json +\& get Retrieve value for a key +\& help Help about any command +\& import Import database dump +\& list List database contents +\& set Insert key/value pair +\& +\& Flags: +\& \-f, \-\-dbfile string DB file to use (default "/home/scip/.config/anydb/default.db") +\& \-d, \-\-debug Enable debugging +\& \-h, \-\-help help for anydb +\& \-v, \-\-version Print program version +\& +\& Use "anydb [command] \-\-help" for more information about a command. +.Ve +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +Anydb is a simple to use commandline tool to store anything you'd +like, even binary files etc. It uses a key/value store (bbolt) in your +home directory. +.SH "LICENSE" +.IX Header "LICENSE" +This software is licensed under the \s-1GNU GENERAL PUBLIC LICENSE\s0 version 3. +.PP +Copyright (c) 2024 by Thomas von Dein +.SH "AUTHORS" +.IX Header "AUTHORS" +Thomas von Dein \fBtom \s-1AT\s0 vondein \s-1DOT\s0 org\fR diff --git a/anydb.pod b/anydb.pod index 21de854..3fdd1aa 100644 --- a/anydb.pod +++ b/anydb.pod @@ -1,5 +1,46 @@ =head1 anydb -FIXME +anydb - a personal key value store + +=head1 SYNOPSIS + + Usage: + anydb [options] [flags] + anydb [command] + + Available Commands: + completion Generate the autocompletion script for the specified shell + del Delete key + export Export database to json + get Retrieve value for a key + help Help about any command + import Import database dump + list List database contents + set Insert key/value pair + + Flags: + -f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db") + -d, --debug Enable debugging + -h, --help help for anydb + -v, --version Print program version + + Use "anydb [command] --help" for more information about a command. + +=head1 DESCRIPTION + +Anydb is a simple to use commandline tool to store anything you'd +like, even binary files etc. It uses a key/value store (bbolt) in your +home directory. + +=head1 LICENSE + +This software is licensed under the GNU GENERAL PUBLIC LICENSE version 3. + +Copyright (c) 2024 by Thomas von Dein + +=head1 AUTHORS + +Thomas von Dein B + =cut diff --git a/cmd/anydb.go b/cmd/anydb.go index 258bf6c..13a1e8b 100644 --- a/cmd/anydb.go +++ b/cmd/anydb.go @@ -2,8 +2,68 @@ package cmd var manpage = ` anydb - FIXME + anydb - a personal key value store + +SYNOPSIS + Usage: + anydb [options] [flags] + anydb [command] + + Available Commands: + completion Generate the autocompletion script for the specified shell + del Delete key + export Export database to json + get Retrieve value for a key + help Help about any command + import Import database dump + list List database contents + set Insert key/value pair + + Flags: + -f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db") + -d, --debug Enable debugging + -h, --help help for anydb + -v, --version Print program version + + Use "anydb [command] --help" for more information about a command. + +DESCRIPTION + Anydb is a simple to use commandline tool to store anything you'd like, + even binary files etc. It uses a key/value store (bbolt) in your home + directory. + +LICENSE + This software is licensed under the GNU GENERAL PUBLIC LICENSE version + 3. + + Copyright (c) 2024 by Thomas von Dein + +AUTHORS + Thomas von Dein tom AT vondein DOT org ` var usage = ` + +Usage: + anydb [options] [flags] + anydb [command] + +Available Commands: + completion Generate the autocompletion script for the specified shell + del Delete key + export Export database to json + get Retrieve value for a key + help Help about any command + import Import database dump + list List database contents + set Insert key/value pair + +Flags: + -f, --dbfile string DB file to use (default "/home/scip/.config/anydb/default.db") + -d, --debug Enable debugging + -h, --help help for anydb + -v, --version Print program version + +Use "anydb [command] --help" for more information about a command. + ` diff --git a/cmd/maincommands.go b/cmd/maincommands.go index 69ceacd..20a7e52 100644 --- a/cmd/maincommands.go +++ b/cmd/maincommands.go @@ -1,8 +1,11 @@ package cmd import ( + "bytes" "errors" + "fmt" "os" + "os/exec" "strings" "github.com/spf13/cobra" @@ -115,8 +118,6 @@ func Del(conf *cfg.Config) *cobra.Command { }, } - cmd.PersistentFlags().StringVarP(&conf.Mode, "output", "o", "", "output to file") - cmd.Aliases = append(cmd.Aliases, "d") cmd.Aliases = append(cmd.Aliases, "rm") @@ -129,19 +130,13 @@ func Export(conf *cfg.Config) *cobra.Command { ) var cmd = &cobra.Command{ - Use: "export []", + Use: "export [-o ]", Short: "Export database to json", Long: `Export database to json`, RunE: func(cmd *cobra.Command, args []string) error { // errors at this stage do not cause the usage to be shown cmd.SilenceUsage = true - if len(args) == 0 { - attr.File = "-" - } else { - attr.File = args[0] - } - conf.Mode = "json" entries, err := conf.DB.List(&attr) @@ -153,6 +148,8 @@ func Export(conf *cfg.Config) *cobra.Command { }, } + cmd.PersistentFlags().StringVarP(&attr.File, "output", "o", "", "output to file") + cmd.Aliases = append(cmd.Aliases, "dump") cmd.Aliases = append(cmd.Aliases, "backup") @@ -219,12 +216,6 @@ func Import(conf *cfg.Config) *cobra.Command { // errors at this stage do not cause the usage to be shown cmd.SilenceUsage = true - if len(args) == 0 { - attr.File = "-" - } else { - attr.File = args[0] - } - return conf.DB.Import(&attr) }, } @@ -244,5 +235,33 @@ func Help(conf *cfg.Config) *cobra.Command { } func Man(conf *cfg.Config) *cobra.Command { - return nil + var cmd = &cobra.Command{ + Use: "man", + Short: "show manual page", + Long: `show manual page`, + RunE: func(cmd *cobra.Command, args []string) error { + // errors at this stage do not cause the usage to be shown + cmd.SilenceUsage = true + + man := exec.Command("less", "-") + + var b bytes.Buffer + + b.WriteString(manpage) + + man.Stdout = os.Stdout + man.Stdin = &b + man.Stderr = os.Stderr + + err := man.Run() + + if err != nil { + return fmt.Errorf("failed to execute 'less': %w", err) + } + + return nil + }, + } + + return cmd } diff --git a/cmd/root.go b/cmd/root.go index c70bc6a..1aacf0c 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -50,7 +50,7 @@ func Execute() { RunE: func(cmd *cobra.Command, args []string) error { if ShowVersion { - fmt.Println(cfg.Version) + fmt.Printf("This is anydb version %s\n", cfg.Version) return nil } @@ -83,8 +83,7 @@ func Execute() { rootCmd.AddCommand(Del(&conf)) rootCmd.AddCommand(Export(&conf)) rootCmd.AddCommand(Import(&conf)) - // rootCmd.AddCommand(Help(&conf)) - // rootCmd.AddCommand(Man(&conf)) + rootCmd.AddCommand(Man(&conf)) err = rootCmd.Execute() if err != nil { diff --git a/go.mod b/go.mod index 85dbfd7..9f2b73f 100644 --- a/go.mod +++ b/go.mod @@ -8,9 +8,11 @@ require ( github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/mattn/go-runewidth v0.0.9 // indirect github.com/olekukonko/tablewriter v0.0.5 // indirect + github.com/rogpeppe/go-internal v1.13.1 // indirect github.com/spf13/cobra v1.8.1 // indirect github.com/spf13/pflag v1.0.5 // indirect go.etcd.io/bbolt v1.3.11 // indirect golang.org/x/sys v0.28.0 // indirect golang.org/x/term v0.27.0 // indirect + golang.org/x/tools v0.22.0 // indirect ) diff --git a/go.sum b/go.sum index 26eb4e0..ce85aab 100644 --- a/go.sum +++ b/go.sum @@ -21,6 +21,8 @@ github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec= github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= +github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM= github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y= @@ -43,6 +45,8 @@ 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.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA= +golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c= google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/main.go b/main.go index 78c9ecf..f51bb60 100644 --- a/main.go +++ b/main.go @@ -11,7 +11,12 @@ import ( ) func main() { + Main() +} + +func Main() int { cmd.Execute() + return 0 } func init() { diff --git a/main_test.go b/main_test.go new file mode 100644 index 0000000..71ba053 --- /dev/null +++ b/main_test.go @@ -0,0 +1,20 @@ +package main + +import ( + "os" + "testing" + + "github.com/rogpeppe/go-internal/testscript" +) + +func TestMain(m *testing.M) { + os.Exit(testscript.RunMain(m, map[string]func() int{ + "anydb": Main, + })) +} + +func TestAnydb(t *testing.T) { + testscript.Run(t, testscript.Params{ + Dir: "t", + }) +} diff --git a/t/files.txtar b/t/files.txtar new file mode 100644 index 0000000..6f0dbc2 --- /dev/null +++ b/t/files.txtar @@ -0,0 +1,17 @@ +# simple file, we cannot use redirection here, so dd is our friend +exec dd if=/dev/random of=file.txt count=5 bs=10 + +# add file to db +exec anydb -f test.db set datum -r file.txt + +# check for existence +exec anydb -f test.db get datum -o out.txt +exists out.txt + +# check if its filled (50 bytes == count=5 x bs=10) +exec ls -l out.txt +stdout 50 + +# look if it's inside the db +exec anydb -f test.db ls +stdout datum.*binary-content diff --git a/t/interface.txtar b/t/interface.txtar new file mode 100644 index 0000000..d8cf1e6 --- /dev/null +++ b/t/interface.txtar @@ -0,0 +1,8 @@ +# check default outputs + +exec anydb -v +stdout 'This is anydb version' + +! exec anydb +stderr 'Available Commands:' + diff --git a/t/restore.txtar b/t/restore.txtar new file mode 100644 index 0000000..9e79aaa --- /dev/null +++ b/t/restore.txtar @@ -0,0 +1,15 @@ +# setup simple db +exec anydb -f test.db set foo bar + +# create backup +exec anydb -f test.db export -o backup.json +stdout 'database contents exported to backup.json' + +# import into new db +exec anydb -f new.db import -r backup.json +stdout 'imported.*entries' + +# check contents +exec anydb -f new.db list +stdout foo.*bar + diff --git a/t/workflow.txtar b/t/workflow.txtar new file mode 100644 index 0000000..bfd0c16 --- /dev/null +++ b/t/workflow.txtar @@ -0,0 +1,50 @@ +# simple entry +exec anydb -f test.db set foo bar + +# entry with tags +exec anydb -f test.db set color grey -t flower,plant + +# simple list +exec anydb -f test.db list +stdout foo.*bar + +# wide list +exec anydb -f test.db list -o wide +stdout 'plant.*now.*grey' + +# list tagged +exec anydb -f test.db list -t flower +! stdout bar + +# list with filter +exec anydb -f test.db list b.r +stdout bar + +# get single entry +exec anydb -f test.db get color +stdout grey + +# modify +exec anydb -f test.db set foo blah + +# check modified +exec anydb -f test.db get foo +stdout blah + +# modify tagged +exec anydb -f test.db set color grey -t butterfly + +# check modified tagged +exec anydb -f test.db list -t butterfly +stdout grey + +# check modified tagged, make sure +exec anydb -f test.db list -t flower +! stdout grey + +# delete entry +exec anydb -f test.db del foo + +# check deleted +exec anydb -f test.db list +! stdout bar