diff --git a/.drone.jsonnet b/.drone.jsonnet new file mode 100644 index 0000000..0928b07 --- /dev/null +++ b/.drone.jsonnet @@ -0,0 +1,136 @@ +local name = 'navidrome'; +local version = '0.62.0'; +local go = '1.25'; +local nginx = '1.24.0'; +local python = '3.12-slim-bookworm'; +local platform = '26.06.01'; +local playwright = 'v1.59.1-jammy'; +local store_publisher = 'stable-303'; +local distros = ['bookworm', 'buster']; + +local platform_image(distro, arch) = + 'syncloud/platform-' + distro + '-' + arch + ':' + platform; + +local build(arch, ui) = [{ + kind: 'pipeline', + type: 'docker', + name: arch, + platform: { + os: 'linux', + arch: arch, + }, + steps: [ + { + name: 'nginx', + image: 'nginx:' + nginx, + commands: ['./nginx/build.sh'], + }, + ] + [ + { + name: 'nginx test ' + distro, + image: platform_image(distro, arch), + commands: ['./nginx/test.sh'], + } + for distro in distros + ] + [ + { + name: 'navidrome', + image: 'debian:bookworm-slim', + commands: ['./navidrome/build.sh ' + version], + }, + ] + [ + { + name: 'navidrome test ' + distro, + image: platform_image(distro, arch), + commands: ['./navidrome/test.sh'], + } + for distro in distros + ] + [ + { + name: 'cli', + image: 'golang:' + go, + commands: ['./cli/build.sh'], + }, + ] + [ + { + name: 'cli test ' + distro, + image: platform_image(distro, arch), + commands: ['./cli/test.sh'], + } + for distro in distros + ] + [ + { + name: 'package', + image: 'debian:bookworm-slim', + commands: ['./package.sh ' + name + ' $DRONE_BUILD_NUMBER'], + }, + ] + [ + { + name: 'test ' + distro, + image: 'python:' + python, + commands: ['./test/ci-test.sh ' + distro + ' ' + arch], + } + for distro in distros + ] + (if ui then [ + { + name: 'test-ui-' + project, + image: 'mcr.microsoft.com/playwright:' + playwright, + commands: ['./web/e2e/ci-ui.sh ' + project], + } + for project in ['desktop'] + ] else []) + [ + { + name: 'publish', + image: 'syncloud/store-publisher:' + store_publisher, + environment: { + SYNCLOUD_TOKEN: { from_secret: 'SYNCLOUD_TOKEN' }, + }, + command: ['snap', '-c', '${DRONE_BRANCH}'], + when: { + branch: ['master', 'stable'], + event: ['push'], + }, + }, + { + name: 'artifact', + image: 'appleboy/drone-scp:1.6.4', + settings: { + host: { from_secret: 'artifact_host' }, + username: 'artifact', + key: { from_secret: 'artifact_key' }, + timeout: '2m', + command_timeout: '2m', + target: '/home/artifact/repo/' + name + '/${DRONE_BUILD_NUMBER}-' + arch, + source: 'artifact/*', + strip_components: 1, + }, + when: { + status: ['failure', 'success'], + event: ['push'], + }, + }, + ], + trigger: { + event: ['push', 'custom'], + }, + services: [ + { + name: name + '.' + distro + '.com', + image: platform_image(distro, arch), + privileged: true, + entrypoint: ['/bin/sh', '-c', "mkdir -p /etc/systemd/system/snapd.service.d && printf '[Service]\\nExecStartPost=/bin/sh -c \"/usr/bin/snap set system refresh.hold=2099-01-01T00:00:00Z\"\\n' > /etc/systemd/system/snapd.service.d/disable-refresh.conf && exec /sbin/init"], + volumes: [ + { name: 'dbus', path: '/var/run/dbus' }, + { name: 'dev', path: '/dev' }, + ], + } + for distro in distros + ], + volumes: [ + { name: 'dbus', host: { path: '/var/run/dbus' } }, + { name: 'dev', host: { path: '/dev' } }, + ], +}]; + +build('amd64', true) + +build('arm64', false) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b1d4c10 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.idea +build/ +artifact/ +*.snap +version +package.name +node_modules/ +test-results/ +cli/bt-* +backend/bin-test-backend diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/README.md b/README.md new file mode 100644 index 0000000..4cecdcb --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Navidrome for Syncloud + +[Navidrome](https://github.com/navidrome/navidrome) music streaming server packaged as a +[Syncloud](https://syncloud.org) app. Subsonic/OpenSubsonic API compatible, so it works with +the existing client ecosystem (Symfonium, Amperfy, play:Sub, DSub, Feishin, …). + +Tracks [syncloud/platform#741](https://github.com/syncloud/platform/issues/741). + +## Authentication + +nginx authenticates every request against the platform's Authelia (`auth_request`) and passes the +user to Navidrome via the trusted `Remote-User` header — no app-specific auth code. + +- **Web UI** — Authelia single sign-on, the same login as the rest of the Syncloud dashboard. +- **Subsonic / mobile apps** — log in with your **Syncloud username and password** using the + client's **HTTP Basic auth** option (validated by Authelia). Open the Navidrome web UI once so + your account is created, then mobile clients work. The Subsonic *token* scheme can't be verified + by Authelia, so use Basic auth. + +## Upstream version + +Pinned in `.drone.jsonnet` (`local version = '...'`). diff --git a/bin/service.navidrome.sh b/bin/service.navidrome.sh new file mode 100755 index 0000000..a7a3cc7 --- /dev/null +++ b/bin/service.navidrome.sh @@ -0,0 +1,15 @@ +#!/bin/bash -e + +/bin/rm -f ${SNAP_DATA}/navidrome.sock + +export ND_ADDRESS=unix:${SNAP_DATA}/navidrome.sock +export ND_UNIXSOCKETPERM=0660 +export ND_DATAFOLDER=${SNAP_DATA}/data +export ND_CACHEFOLDER=${SNAP_DATA}/cache +export ND_MUSICFOLDER=/data/navidrome +export ND_EXTAUTH_USERHEADER=Remote-User +export ND_EXTAUTH_TRUSTEDSOURCES=@ +export ND_LOGLEVEL=info +export ND_ENABLEINSIGHTSCOLLECTOR=false + +exec ${SNAP}/navidrome/navidrome diff --git a/bin/service.nginx.sh b/bin/service.nginx.sh new file mode 100755 index 0000000..579ee85 --- /dev/null +++ b/bin/service.nginx.sh @@ -0,0 +1,4 @@ +#!/bin/bash -e + +/bin/rm -f ${SNAP_COMMON}/web.socket +exec ${SNAP}/nginx/bin/nginx.sh -c ${SNAP_DATA}/config/nginx.conf -p ${SNAP}/nginx -e stderr diff --git a/cli/build.sh b/cli/build.sh new file mode 100755 index 0000000..ad9f469 --- /dev/null +++ b/cli/build.sh @@ -0,0 +1,16 @@ +#!/bin/bash -ex + +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) +cd ${DIR} + +BIN_OUT=${DIR}/../build/snap/bin +HOOKS_OUT=${DIR}/../build/snap/meta/hooks +mkdir -p ${BIN_OUT} ${HOOKS_OUT} + +go vet ./... + +CGO_ENABLED=0 go build -buildvcs=false -o ${HOOKS_OUT}/install ./cmd/install +CGO_ENABLED=0 go build -buildvcs=false -o ${HOOKS_OUT}/configure ./cmd/configure +CGO_ENABLED=0 go build -buildvcs=false -o ${HOOKS_OUT}/pre-refresh ./cmd/pre-refresh +CGO_ENABLED=0 go build -buildvcs=false -o ${HOOKS_OUT}/post-refresh ./cmd/post-refresh +CGO_ENABLED=0 go build -buildvcs=false -o ${BIN_OUT}/cli ./cmd/cli diff --git a/cli/cmd/cli/main.go b/cli/cmd/cli/main.go new file mode 100644 index 0000000..47c2c0e --- /dev/null +++ b/cli/cmd/cli/main.go @@ -0,0 +1,68 @@ +package main + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" + "go.uber.org/zap" + "hooks/installer" + "hooks/log" +) + +func main() { + cmd := &cobra.Command{ + Use: "cli", + SilenceUsage: true, + } + + cmd.AddCommand(&cobra.Command{ + Use: "storage-change", + RunE: func(cmd *cobra.Command, args []string) error { + logger := log.Logger(zap.DebugLevel) + logger.Info("storage-change") + return installer.New(logger).StorageChange() + }, + }) + + cmd.AddCommand(&cobra.Command{ + Use: "access-change", + RunE: func(cmd *cobra.Command, args []string) error { + logger := log.Logger(zap.DebugLevel) + logger.Info("access-change") + return installer.New(logger).AccessChange() + }, + }) + + cmd.AddCommand(&cobra.Command{ + Use: "backup-pre-stop", + RunE: func(cmd *cobra.Command, args []string) error { + logger := log.Logger(zap.DebugLevel) + logger.Info("backup-pre-stop") + return installer.New(logger).BackupPreStop() + }, + }) + + cmd.AddCommand(&cobra.Command{ + Use: "restore-pre-start", + RunE: func(cmd *cobra.Command, args []string) error { + logger := log.Logger(zap.DebugLevel) + logger.Info("restore-pre-start") + return installer.New(logger).RestorePreStart() + }, + }) + + cmd.AddCommand(&cobra.Command{ + Use: "restore-post-start", + RunE: func(cmd *cobra.Command, args []string) error { + logger := log.Logger(zap.DebugLevel) + logger.Info("restore-post-start") + return installer.New(logger).RestorePostStart() + }, + }) + + if err := cmd.Execute(); err != nil { + fmt.Print(err) + os.Exit(1) + } +} diff --git a/cli/cmd/configure/main.go b/cli/cmd/configure/main.go new file mode 100644 index 0000000..091c7e8 --- /dev/null +++ b/cli/cmd/configure/main.go @@ -0,0 +1,24 @@ +package main + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" + "go.uber.org/zap" + "hooks/installer" + "hooks/log" +) + +func main() { + rootCmd := &cobra.Command{ + SilenceUsage: true, + RunE: func(cmd *cobra.Command, args []string) error { + return installer.New(log.Logger(zap.DebugLevel)).Configure() + }, + } + if err := rootCmd.Execute(); err != nil { + fmt.Print(err) + os.Exit(1) + } +} diff --git a/cli/cmd/install/main.go b/cli/cmd/install/main.go new file mode 100644 index 0000000..587cd7a --- /dev/null +++ b/cli/cmd/install/main.go @@ -0,0 +1,25 @@ +package main + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" + "go.uber.org/zap" + "hooks/installer" + "hooks/log" +) + +func main() { + rootCmd := &cobra.Command{ + Use: "install", + SilenceUsage: true, + RunE: func(cmd *cobra.Command, args []string) error { + return installer.New(log.Logger(zap.DebugLevel)).Install() + }, + } + if err := rootCmd.Execute(); err != nil { + fmt.Print(err) + os.Exit(1) + } +} diff --git a/cli/cmd/post-refresh/main.go b/cli/cmd/post-refresh/main.go new file mode 100644 index 0000000..1be7c8e --- /dev/null +++ b/cli/cmd/post-refresh/main.go @@ -0,0 +1,24 @@ +package main + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" + "go.uber.org/zap" + "hooks/installer" + "hooks/log" +) + +func main() { + rootCmd := &cobra.Command{ + SilenceUsage: true, + RunE: func(cmd *cobra.Command, args []string) error { + return installer.New(log.Logger(zap.DebugLevel)).PostRefresh() + }, + } + if err := rootCmd.Execute(); err != nil { + fmt.Print(err) + os.Exit(1) + } +} diff --git a/cli/cmd/pre-refresh/main.go b/cli/cmd/pre-refresh/main.go new file mode 100644 index 0000000..d674202 --- /dev/null +++ b/cli/cmd/pre-refresh/main.go @@ -0,0 +1,24 @@ +package main + +import ( + "fmt" + "os" + + "github.com/spf13/cobra" + "go.uber.org/zap" + "hooks/installer" + "hooks/log" +) + +func main() { + rootCmd := &cobra.Command{ + SilenceUsage: true, + RunE: func(cmd *cobra.Command, args []string) error { + return installer.New(log.Logger(zap.DebugLevel)).PreRefresh() + }, + } + if err := rootCmd.Execute(); err != nil { + fmt.Print(err) + os.Exit(1) + } +} diff --git a/cli/go.mod b/cli/go.mod new file mode 100644 index 0000000..5009f48 --- /dev/null +++ b/cli/go.mod @@ -0,0 +1,17 @@ +module hooks + +go 1.23 + +require ( + github.com/otiai10/copy v1.12.0 + github.com/spf13/cobra v1.7.0 + github.com/syncloud/golib v1.1.17 + go.uber.org/zap v1.25.0 +) + +require ( + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/spf13/pflag v1.0.5 // indirect + go.uber.org/multierr v1.10.0 // indirect + golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect +) diff --git a/cli/go.sum b/cli/go.sum new file mode 100644 index 0000000..c574fdf --- /dev/null +++ b/cli/go.sum @@ -0,0 +1,33 @@ +github.com/benbjohnson/clock v1.3.0 h1:ip6w0uFQkncKQ979AypyG0ER7mqUSBdKLOgAle/AT8A= +github.com/benbjohnson/clock v1.3.0/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA= +github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/otiai10/copy v1.12.0 h1:cLMgSQnXBs1eehF0Wy/FAGsgDTDmAqFR7rQylBb1nDY= +github.com/otiai10/copy v1.12.0/go.mod h1:rSaLseMUsZFFbsFGc7wCJnnkTAvdc5L6VWxPE4308Ww= +github.com/otiai10/mint v1.5.1 h1:XaPLeE+9vGbuyEHem1JNk3bYc7KKqyI/na0/mLd/Kks= +github.com/otiai10/mint v1.5.1/go.mod h1:MJm72SBthJjz8qhefc4z1PYEieWmy8Bku7CjcAqyUSM= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I= +github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0= +github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= +github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/syncloud/golib v1.1.17 h1:/TddxLOGa8ujEb6DahvVC9UP6onDAwfR85+JDqZfSqc= +github.com/syncloud/golib v1.1.17/go.mod h1:XmmoqNuegLnl27FbmzLj60dTR/tN7c1X7Qp3uUPRC88= +go.uber.org/goleak v1.2.0 h1:xqgm/S+aQvhWFTtR0XK3Jvg7z8kGV8P4X14IzwN3Eqk= +go.uber.org/goleak v1.2.0/go.mod h1:XJYK+MuIchqpmGmUSAzotztawfKvYLUIgg7guXrwVUo= +go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ= +go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.25.0 h1:4Hvk6GtkucQ790dqmj7l1eEnRdKm3k3ZUrUMS2d5+5c= +go.uber.org/zap v1.25.0/go.mod h1:JIAUzQIH94IC4fOJQm7gMmBJP5k7wQfdcnYdPoEXJYk= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/cli/installer/installer.go b/cli/installer/installer.go new file mode 100644 index 0000000..39954d0 --- /dev/null +++ b/cli/installer/installer.go @@ -0,0 +1,178 @@ +package installer + +import ( + "fmt" + "os" + "path" + + cp "github.com/otiai10/copy" + "github.com/syncloud/golib/config" + "github.com/syncloud/golib/linux" + "github.com/syncloud/golib/platform" + "go.uber.org/zap" +) + +type Variables struct { + App string + AppDir string + DataDir string + CommonDir string + StorageDir string + Socket string + AuthUrl string + AuthLocalSocket string +} + +const ( + App = "navidrome" + AppDir = "/snap/navidrome/current" + DataDir = "/var/snap/navidrome/current" + CommonDir = "/var/snap/navidrome/common" +) + +type Installer struct { + newVersionFile string + currentVersionFile string + platformClient *platform.Client + installFile string + logger *zap.Logger +} + +func New(logger *zap.Logger) *Installer { + return &Installer{ + newVersionFile: path.Join(AppDir, "version"), + currentVersionFile: path.Join(DataDir, "version"), + platformClient: platform.New(), + installFile: path.Join(CommonDir, "installed"), + logger: logger, + } +} + +func (i *Installer) Install() error { + return i.UpdateConfigs() +} + +func (i *Installer) Configure() error { + if i.IsInstalled() { + return i.Upgrade() + } + return i.Initialize() +} + +func (i *Installer) IsInstalled() bool { + _, err := os.Stat(i.installFile) + return err == nil +} + +func (i *Installer) Initialize() error { + if err := i.StorageChange(); err != nil { + return err + } + if err := os.WriteFile(i.installFile, []byte("installed"), 0644); err != nil { + return err + } + return i.UpdateVersion() +} + +func (i *Installer) Upgrade() error { + if err := i.StorageChange(); err != nil { + return err + } + return i.UpdateVersion() +} + +func (i *Installer) PreRefresh() error { + return nil +} + +func (i *Installer) PostRefresh() error { + if err := i.UpdateConfigs(); err != nil { + return err + } + if err := i.ClearVersion(); err != nil { + return err + } + return i.FixPermissions() +} + +func (i *Installer) AccessChange() error { + return i.UpdateConfigs() +} + +func (i *Installer) StorageChange() error { + storageDir, err := i.platformClient.InitStorage(App, App) + if err != nil { + return err + } + return linux.Chown(storageDir, App) +} + +func (i *Installer) ClearVersion() error { + return os.RemoveAll(i.currentVersionFile) +} + +func (i *Installer) UpdateVersion() error { + return cp.Copy(i.newVersionFile, i.currentVersionFile) +} + +func (i *Installer) UpdateConfigs() error { + if err := linux.CreateUser(App); err != nil { + return err + } + if err := i.StorageChange(); err != nil { + return err + } + if err := linux.CreateMissingDirs( + path.Join(DataDir, "config"), + path.Join(DataDir, "nginx"), + path.Join(DataDir, "data"), + path.Join(DataDir, "cache"), + ); err != nil { + return err + } + + storageDir, err := i.platformClient.InitStorage(App, App) + if err != nil { + return err + } + if err := i.GenerateConfig(storageDir); err != nil { + return fmt.Errorf("generate config: %w", err) + } + + return i.FixPermissions() +} + +func (i *Installer) GenerateConfig(storageDir string) error { + authUrl, err := i.platformClient.GetAppUrl("auth") + if err != nil { + return err + } + + variables := Variables{ + App: App, + AppDir: AppDir, + DataDir: DataDir, + CommonDir: CommonDir, + StorageDir: storageDir, + Socket: path.Join(DataDir, "navidrome.sock"), + AuthUrl: authUrl, + AuthLocalSocket: i.platformClient.GetAuthLocalSocket(), + } + + return config.Generate( + path.Join(AppDir, "config"), + path.Join(DataDir, "config"), + variables, + ) +} + +func (i *Installer) FixPermissions() error { + if err := linux.Chown(DataDir, App); err != nil { + return err + } + return linux.Chown(CommonDir, App) +} + +func (i *Installer) BackupPreStop() error { return i.PreRefresh() } +func (i *Installer) RestorePreStart() error { return i.PostRefresh() } +func (i *Installer) RestorePostStart() error { return i.Configure() } diff --git a/cli/log/logger.go b/cli/log/logger.go new file mode 100644 index 0000000..41f61c6 --- /dev/null +++ b/cli/log/logger.go @@ -0,0 +1,21 @@ +package log + +import ( + "fmt" + + "go.uber.org/zap" + "go.uber.org/zap/zapcore" +) + +func Logger(level zapcore.Level) *zap.Logger { + logConfig := zap.NewProductionConfig() + logConfig.Encoding = "console" + logConfig.EncoderConfig.TimeKey = "" + logConfig.EncoderConfig.ConsoleSeparator = " " + logConfig.Level = zap.NewAtomicLevelAt(level) + logger, err := logConfig.Build() + if err != nil { + panic(fmt.Sprintf("can't initialize zap logger: %v", err)) + } + return logger +} diff --git a/cli/test.sh b/cli/test.sh new file mode 100755 index 0000000..902bab8 --- /dev/null +++ b/cli/test.sh @@ -0,0 +1,7 @@ +#!/bin/sh -ex + +DIR=$( cd "$( dirname "$0" )" && pwd ) +cd ${DIR} + +BUILD_DIR=${DIR}/../build/snap +${BUILD_DIR}/bin/cli --help diff --git a/config/authelia-authrequest-basic.conf b/config/authelia-authrequest-basic.conf new file mode 100644 index 0000000..aaf7c07 --- /dev/null +++ b/config/authelia-authrequest-basic.conf @@ -0,0 +1,14 @@ +## Send a subrequest to Authelia to verify if the user is authenticated and has permission to access the resource. +auth_request /internal/authelia/authz/basic; + +## Save the upstream response headers from Authelia to variables. +auth_request_set $user $upstream_http_remote_user; +auth_request_set $groups $upstream_http_remote_groups; +auth_request_set $name $upstream_http_remote_name; +auth_request_set $email $upstream_http_remote_email; + +## Inject the response headers from the variables into the request made to the backend. +proxy_set_header Remote-User $user; +proxy_set_header Remote-Groups $groups; +proxy_set_header Remote-Name $name; +proxy_set_header Remote-Email $email; diff --git a/config/authelia-authrequest.conf b/config/authelia-authrequest.conf new file mode 100644 index 0000000..4cd168d --- /dev/null +++ b/config/authelia-authrequest.conf @@ -0,0 +1,32 @@ +## Send a subrequest to Authelia to verify if the user is authenticated and has permission to access the resource. +auth_request /internal/authelia/authz; + +## Save the upstream metadata response headers from Authelia to variables. +auth_request_set $user $upstream_http_remote_user; +auth_request_set $groups $upstream_http_remote_groups; +auth_request_set $name $upstream_http_remote_name; +auth_request_set $email $upstream_http_remote_email; + +## Inject the metadata response headers from the variables into the request made to the backend. +proxy_set_header Remote-User $user; +proxy_set_header Remote-Groups $groups; +proxy_set_header Remote-Email $email; +proxy_set_header Remote-Name $name; + +## Configure the redirection when the authz failure occurs. Lines starting with 'Modern Method' and 'Legacy Method' +## should be commented / uncommented as pairs. The modern method uses the session cookies configuration's authelia_url +## value to determine the redirection URL here. It's much simpler and compatible with the mutli-cookie domain easily. + +## Modern Method: Set the $redirection_url to the Location header of the response to the Authz endpoint. +auth_request_set $redirection_url $upstream_http_location; + +## Modern Method: When there is a 401 response code from the authz endpoint redirect to the $redirection_url. +error_page 401 =302 $redirection_url; + +## Legacy Method: Set $target_url to the original requested URL. +## This requires http_set_misc module, replace 'set_escape_uri' with 'set' if you don't have this module. +# set_escape_uri $target_url $scheme://$http_host$request_uri; + +## Legacy Method: When there is a 401 response code from the authz endpoint redirect to the portal with the 'rd' +## URL parameter set to $target_url. This requires users update 'auth.example.com/' with their external authelia URL. +# error_page 401 =302 {{ .AuthUrl }}/?rd=$target_url; diff --git a/config/authelia-location-basic.conf b/config/authelia-location-basic.conf new file mode 100644 index 0000000..21807c7 --- /dev/null +++ b/config/authelia-location-basic.conf @@ -0,0 +1,37 @@ +#set $upstream_authelia http://authelia:9091/api/authz/auth-request; + +# Virtual endpoint created by nginx to forward auth requests. +location /internal/authelia/authz/basic { + ## Essential Proxy Configuration + internal; + proxy_pass {{ .AuthLocalSocket }}/api/authz/auth-request; + + ## Headers + ## The headers starting with X-* are required. + proxy_set_header X-Original-Method $request_method; + proxy_set_header X-Original-URL https://$http_host$request_uri; + proxy_set_header X-Original-Method $request_method; + proxy_set_header X-Forwarded-Method $request_method; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $http_host; + proxy_set_header X-Forwarded-URI $request_uri; + proxy_set_header X-Forwarded-For $remote_addr; + proxy_set_header Content-Length ""; + proxy_set_header Connection ""; + + ## Basic Proxy Configuration + proxy_pass_request_body off; + proxy_next_upstream error timeout invalid_header http_500 http_502 http_503; # Timeout if the real server is dead + proxy_redirect http:// $scheme://; + proxy_http_version 1.1; + proxy_cache_bypass $cookie_session; + proxy_no_cache $cookie_session; + proxy_buffers 4 32k; + client_body_buffer_size 128k; + + ## Advanced Proxy Configuration + send_timeout 5m; + proxy_read_timeout 240; + proxy_send_timeout 240; + proxy_connect_timeout 240; +} diff --git a/config/authelia-location.conf b/config/authelia-location.conf new file mode 100644 index 0000000..282bb96 --- /dev/null +++ b/config/authelia-location.conf @@ -0,0 +1,32 @@ +# set $upstream_authelia https://authelia/api/authz/auth-request; + +## Virtual endpoint created by nginx to forward auth requests. +location /internal/authelia/authz { + ## Essential Proxy Configuration + internal; + proxy_pass {{ .AuthLocalSocket }}/api/authz/auth-request; + + ## Headers + ## The headers starting with X-* are required. + proxy_set_header X-Original-Method $request_method; + proxy_set_header X-Original-URL https://$http_host$request_uri; + proxy_set_header X-Forwarded-For $remote_addr; + proxy_set_header Content-Length ""; + proxy_set_header Connection ""; + + ## Basic Proxy Configuration + proxy_pass_request_body off; + proxy_next_upstream error timeout invalid_header http_500 http_502 http_503; # Timeout if the real server is dead + proxy_redirect http:// $scheme://; + proxy_http_version 1.1; + proxy_cache_bypass $cookie_session; + proxy_no_cache $cookie_session; + proxy_buffers 4 32k; + client_body_buffer_size 128k; + + ## Advanced Proxy Configuration + send_timeout 5m; + proxy_read_timeout 240; + proxy_send_timeout 240; + proxy_connect_timeout 240; +} diff --git a/config/nginx.conf b/config/nginx.conf new file mode 100644 index 0000000..e23a9f5 --- /dev/null +++ b/config/nginx.conf @@ -0,0 +1,64 @@ +pid {{ .DataDir }}/nginx.pid; +daemon off; +worker_processes auto; + +error_log syslog:server=unix:/dev/log warn; + +events { + worker_connections 1024; +} + +http { + access_log syslog:server=unix:/dev/log; + include {{ .AppDir }}/nginx/etc/nginx/mime.types; + + client_body_temp_path {{ .DataDir }}/nginx/client_body_temp; + proxy_temp_path {{ .DataDir }}/nginx/proxy_temp; + fastcgi_temp_path {{ .DataDir }}/nginx/fastcgi_temp; + uwsgi_temp_path {{ .DataDir }}/nginx/uwsgi_temp; + scgi_temp_path {{ .DataDir }}/nginx/scgi_temp; + + client_max_body_size 0; + + map $http_upgrade $connection_upgrade { + default upgrade; + '' close; + } + + upstream navidrome { + server unix:{{ .Socket }}; + } + + server { + listen unix:{{ .CommonDir }}/web.socket; + + set_real_ip_from unix:; + server_name localhost; + + include {{ .DataDir }}/config/authelia-location.conf; + include {{ .DataDir }}/config/authelia-location-basic.conf; + + location /rest/ { + include {{ .DataDir }}/config/proxy.conf; + include {{ .DataDir }}/config/authelia-authrequest-basic.conf; + + proxy_pass http://navidrome; + proxy_http_version 1.1; + proxy_set_header Connection ""; + proxy_buffering off; + proxy_redirect off; + } + + location / { + include {{ .DataDir }}/config/proxy.conf; + include {{ .DataDir }}/config/authelia-authrequest.conf; + + proxy_pass http://navidrome; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + proxy_buffering off; + proxy_redirect off; + } + } +} diff --git a/config/proxy.conf b/config/proxy.conf new file mode 100644 index 0000000..04dfb33 --- /dev/null +++ b/config/proxy.conf @@ -0,0 +1,8 @@ +## Headers +proxy_set_header Host $host; +proxy_set_header X-Original-URL $scheme://$http_host$request_uri; +proxy_set_header X-Forwarded-Proto $scheme; +proxy_set_header X-Forwarded-Host $http_host; +proxy_set_header X-Forwarded-URI $request_uri; +proxy_set_header X-Forwarded-Ssl on; +proxy_set_header X-Forwarded-For $remote_addr; \ No newline at end of file diff --git a/meta/gui/icon.png b/meta/gui/icon.png new file mode 100644 index 0000000..a136a6a Binary files /dev/null and b/meta/gui/icon.png differ diff --git a/meta/snap.yaml b/meta/snap.yaml new file mode 100644 index 0000000..9621e8d --- /dev/null +++ b/meta/snap.yaml @@ -0,0 +1,38 @@ +name: navidrome +summary: Navidrome +description: Navidrome music streaming server, Subsonic/OpenSubsonic API compatible + +apps: + navidrome: + user: navidrome + command: bin/service.navidrome.sh + daemon: simple + restart-condition: always + start-timeout: 600s + restart-delay: 10s + + nginx: + user: navidrome + command: bin/service.nginx.sh + daemon: simple + restart-condition: always + start-timeout: 600s + restart-delay: 10s + + cli: + command: bin/cli + + storage-change: + command: bin/cli storage-change + + access-change: + command: bin/cli access-change + + backup-pre-stop: + command: bin/cli backup-pre-stop + + restore-pre-start: + command: bin/cli restore-pre-start + + restore-post-start: + command: bin/cli restore-post-start diff --git a/navidrome/build.sh b/navidrome/build.sh new file mode 100755 index 0000000..ddbfb74 --- /dev/null +++ b/navidrome/build.sh @@ -0,0 +1,31 @@ +#!/bin/bash -ex + +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) +cd ${DIR} + +VERSION=$1 +if [[ -z "${VERSION}" ]]; then + echo "usage $0 version" + exit 1 +fi + +BUILD_DIR=${DIR}/../build/snap/navidrome +mkdir -p ${BUILD_DIR} + +ARCH=$(dpkg --print-architecture) +case ${ARCH} in + amd64) NARCH=amd64 ;; + arm64) NARCH=arm64 ;; + armhf) NARCH=armv7 ;; + *) echo "unsupported arch ${ARCH}"; exit 1 ;; +esac + +apt-get update +apt-get install -y wget ca-certificates + +wget -c --progress=dot:giga \ + https://github.com/navidrome/navidrome/releases/download/v${VERSION}/navidrome_${VERSION}_linux_${NARCH}.tar.gz \ + -O ${DIR}/../build/navidrome.tar.gz + +tar xf ${DIR}/../build/navidrome.tar.gz -C ${BUILD_DIR} navidrome +chmod +x ${BUILD_DIR}/navidrome diff --git a/navidrome/test.sh b/navidrome/test.sh new file mode 100755 index 0000000..6c03db6 --- /dev/null +++ b/navidrome/test.sh @@ -0,0 +1,8 @@ +#!/bin/sh -ex + +DIR=$( cd "$( dirname "$0" )" && pwd ) +cd ${DIR} + +BUILD_DIR=${DIR}/../build/snap/navidrome +${BUILD_DIR}/navidrome --help > /dev/null +echo "navidrome binary ok" diff --git a/nginx/bin/nginx.sh b/nginx/bin/nginx.sh new file mode 100755 index 0000000..2aeb1c7 --- /dev/null +++ b/nginx/bin/nginx.sh @@ -0,0 +1,5 @@ +#!/bin/bash -e +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd ) +LIBS=$(echo ${DIR}/lib/*-linux-gnu*) +LIBS=$LIBS:$(echo ${DIR}/usr/lib/*-linux-gnu*) +${DIR}/lib/*-linux*/ld-*.so --library-path $LIBS ${DIR}/usr/sbin/nginx "$@" diff --git a/nginx/build.sh b/nginx/build.sh new file mode 100755 index 0000000..42c103b --- /dev/null +++ b/nginx/build.sh @@ -0,0 +1,13 @@ +#!/bin/sh -ex + +DIR=$( cd "$( dirname "$0" )" && pwd ) +cd ${DIR} + +BUILD_DIR=${DIR}/../build/snap/nginx +mkdir -p ${BUILD_DIR} +cp -r /etc ${BUILD_DIR} +cp -r /opt ${BUILD_DIR} +cp -r /usr ${BUILD_DIR} +cp -r /bin ${BUILD_DIR} +cp -r /lib ${BUILD_DIR} +cp -r ${DIR}/bin/* ${BUILD_DIR}/bin diff --git a/nginx/test.sh b/nginx/test.sh new file mode 100755 index 0000000..dccd169 --- /dev/null +++ b/nginx/test.sh @@ -0,0 +1,7 @@ +#!/bin/sh -ex + +DIR=$( cd "$( dirname "$0" )" && pwd ) +cd ${DIR} + +BUILD_DIR=${DIR}/../build/snap/nginx +${BUILD_DIR}/bin/nginx.sh -version diff --git a/package.sh b/package.sh new file mode 100755 index 0000000..ad2e003 --- /dev/null +++ b/package.sh @@ -0,0 +1,38 @@ +#!/bin/bash -ex + +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) +cd ${DIR} + +if [[ -z "$2" ]]; then + echo "usage $0 app version" + exit 1 +fi + +NAME=$1 +VERSION=$2 +echo $VERSION > ${DIR}/version +ARCH=$(dpkg --print-architecture) + +SNAP_DIR=${DIR}/build/snap + +apt update +apt -y install squashfs-tools + +cp -r ${DIR}/bin ${SNAP_DIR} +cp -r ${DIR}/config ${SNAP_DIR} +mkdir -p ${SNAP_DIR}/meta +cp ${DIR}/meta/snap.yaml ${SNAP_DIR}/meta/snap.yaml +cp -r ${DIR}/meta/gui ${SNAP_DIR}/meta/gui + +echo "version: $VERSION" >> ${SNAP_DIR}/meta/snap.yaml +echo "architectures:" >> ${SNAP_DIR}/meta/snap.yaml +echo "- ${ARCH}" >> ${SNAP_DIR}/meta/snap.yaml +echo $VERSION > ${SNAP_DIR}/version + +du -d2 -h $SNAP_DIR | sort -h | tail -50 + +PACKAGE=${NAME}_${VERSION}_${ARCH}.snap +echo ${PACKAGE} > ${DIR}/package.name +mksquashfs ${SNAP_DIR} ${DIR}/${PACKAGE} -noappend -comp xz -no-xattrs -all-root +mkdir ${DIR}/artifact +cp ${DIR}/${PACKAGE} ${DIR}/artifact diff --git a/test/__init__.py b/test/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/ci-test.sh b/test/ci-test.sh new file mode 100755 index 0000000..6045031 --- /dev/null +++ b/test/ci-test.sh @@ -0,0 +1,18 @@ +#!/bin/bash -ex + +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd ) + +DISTRO=$1 +ARCH=$2 +NAME=navidrome +DOMAIN="${DISTRO}.com" +APP_DOMAIN="${NAME}.${DOMAIN}" + +getent hosts $APP_DOMAIN | sed "s/$APP_DOMAIN/auth.$DOMAIN/g" | tee -a /etc/hosts +cat /etc/hosts + +APP_ARCHIVE_PATH=$(realpath $(cat ${DIR}/package.name)) + +cd ${DIR}/test +./deps.sh +py.test -x -s test.py --distro=$DISTRO --app-archive-path=$APP_ARCHIVE_PATH --app=$NAME --arch=$ARCH diff --git a/test/conftest.py b/test/conftest.py new file mode 100644 index 0000000..406a2f2 --- /dev/null +++ b/test/conftest.py @@ -0,0 +1,9 @@ +from os.path import dirname, join +from syncloudlib.integration.conftest import * + +DIR = dirname(__file__) + + +@pytest.fixture(scope="session") +def project_dir(): + return join(DIR, '..') diff --git a/test/deps.sh b/test/deps.sh new file mode 100755 index 0000000..d9175f2 --- /dev/null +++ b/test/deps.sh @@ -0,0 +1,9 @@ +#!/bin/bash -e +DIR=$( cd "$( dirname "$0" )" && pwd ) + +while ! apt-get update; do + sleep 1 + echo "retry" +done +apt-get install -y sshpass openssh-client wget +pip install -r requirements.txt diff --git a/test/pytest.ini b/test/pytest.ini new file mode 100644 index 0000000..dbcb406 --- /dev/null +++ b/test/pytest.ini @@ -0,0 +1,3 @@ +[pytest] +log_cli = True +log_level=INFO diff --git a/test/requirements.txt b/test/requirements.txt new file mode 100644 index 0000000..7ea651d --- /dev/null +++ b/test/requirements.txt @@ -0,0 +1,5 @@ +pytest==8.4.1 +selenium==4.21.0 +syncloud-lib==365 +retry==0.9.2 +pytest-retry==1.6.3 diff --git a/test/test.py b/test/test.py new file mode 100644 index 0000000..f21af46 --- /dev/null +++ b/test/test.py @@ -0,0 +1,110 @@ +import time +from subprocess import check_output + +import pytest +import requests +from requests.packages.urllib3.exceptions import InsecureRequestWarning +from syncloudlib.integration.hosts import add_host_alias +from syncloudlib.integration.installer import local_install + +TMP_DIR = '/tmp/syncloud' +APP = 'navidrome' + +requests.packages.urllib3.disable_warnings(InsecureRequestWarning) + + +@pytest.fixture(scope="session") +def module_setup(request, device, artifact_dir): + def module_teardown(): + device.run_ssh('ls -la /var/snap/{0}/current > {1}/var.current.ls.log'.format(APP, TMP_DIR), throw=False) + device.run_ssh('cat /var/snap/{0}/current/config/nginx.conf > {1}/nginx.conf.log'.format(APP, TMP_DIR), throw=False) + device.run_ssh('journalctl -u snap.{0}.navidrome --no-pager | tail -2000 > {1}/navidrome.log'.format(APP, TMP_DIR), throw=False) + device.run_ssh('journalctl -u snap.{0}.nginx --no-pager | tail -2000 > {1}/nginx.log'.format(APP, TMP_DIR), throw=False) + device.run_ssh('journalctl --no-pager | tail -3000 > {0}/journalctl.log'.format(TMP_DIR), throw=False) + device.scp_from_device('{0}/*'.format(TMP_DIR), artifact_dir) + check_output('chmod -R a+r {0}'.format(artifact_dir), shell=True) + + request.addfinalizer(module_teardown) + + +def provision_user(app_domain, user, password): + session = requests.session() + for _ in range(30): + r = session.get("https://{0}/app/".format(app_domain), auth=(user, password), verify=False, timeout=10) + if r.status_code == 200: + return True + time.sleep(2) + return False + + +def subsonic_ping(app_domain, user, password): + session = requests.session() + return session.get( + "https://{0}/rest/ping".format(app_domain), + params={'v': '1.16.1', 'c': 'syncloud-test', 'f': 'json'}, + auth=(user, password), verify=False, timeout=10) + + +def test_start(module_setup, device, device_host, app, domain): + add_host_alias(app, device_host, domain) + device.run_ssh('date', retries=100) + device.run_ssh('mkdir {0}'.format(TMP_DIR)) + + +@pytest.mark.flaky(retries=50, delay=10) +def test_activate_device(device): + device.run_ssh('rm -f /var/snap/platform/current/syncloud.crt', throw=False) + response = device.activate_custom() + assert response.status_code == 200, response.text + + +def test_install(app_archive_path, device_host, device_password): + local_install(device_host, device_password, app_archive_path) + + +def test_sockets(device): + device.run_ssh('test -S /var/snap/navidrome/current/navidrome.sock', retries=30) + device.run_ssh('test -S /var/snap/navidrome/common/web.socket', retries=30) + + +def test_web_requires_auth(app_domain): + session = requests.session() + last = None + for _ in range(60): + r = session.get("https://{0}/".format(app_domain), verify=False, allow_redirects=False, timeout=10) + last = r.status_code + if r.status_code in (301, 302, 303): + assert 'auth.' in r.headers.get('Location', ''), r.headers.get('Location') + return + time.sleep(2) + assert False, "expected redirect to Authelia portal, last status {0}".format(last) + + +@pytest.mark.flaky(retries=10, delay=6) +def test_subsonic_login_via_authelia(app_domain, device_user, device_password): + assert provision_user(app_domain, device_user, device_password), "web provisioning failed" + r = subsonic_ping(app_domain, device_user, device_password) + assert r.status_code == 200, r.text + assert r.json().get('subsonic-response', {}).get('status') == 'ok', r.text + + +def test_subsonic_rejects_wrong_password(app_domain, device_user): + r = subsonic_ping(app_domain, device_user, 'definitely-wrong') + assert r.status_code == 401, "expected 401 from authelia basic, got {0}: {1}".format(r.status_code, r.text[:200]) + + +def test_remove(device, app): + response = device.app_remove(app) + assert response.status_code == 200, response.text + + +def test_reinstall(app_archive_path, device_host, device_password): + local_install(device_host, device_password, app_archive_path) + + +@pytest.mark.flaky(retries=10, delay=6) +def test_subsonic_after_reinstall(app_domain, device_user, device_password): + assert provision_user(app_domain, device_user, device_password), "web provisioning failed after reinstall" + r = subsonic_ping(app_domain, device_user, device_password) + assert r.status_code == 200, r.text + assert r.json().get('subsonic-response', {}).get('status') == 'ok', r.text diff --git a/web/e2e/ci-ui.sh b/web/e2e/ci-ui.sh new file mode 100755 index 0000000..c014cff --- /dev/null +++ b/web/e2e/ci-ui.sh @@ -0,0 +1,32 @@ +#!/bin/bash -ex + +DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) + +PROJECT="${1:-desktop}" +NAME=navidrome +export PLAYWRIGHT_DOMAIN="${PLAYWRIGHT_DOMAIN:-bookworm.com}" +export PLAYWRIGHT_USER="${PLAYWRIGHT_USER:-user}" +export PLAYWRIGHT_PASSWORD="${PLAYWRIGHT_PASSWORD:-Password1}" + +DOMAIN="$PLAYWRIGHT_DOMAIN" +APP_DOMAIN="${NAME}.${DOMAIN}" +SSH_PASS="${PLAYWRIGHT_SSH_PASSWORD:-$PLAYWRIGHT_PASSWORD}" + +getent hosts $APP_DOMAIN | sed "s/$APP_DOMAIN/auth.$DOMAIN/g" | tee -a /etc/hosts +cat /etc/hosts + +apt-get update -qq +apt-get install -y -qq sshpass openssh-client + +SSH_OPTS="-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o LogLevel=ERROR -o ConnectTimeout=15" + +# Navidrome has no upload UI: music is added by placing files in the library folder. +# Put a sample track there (the real way users add music) and force a rescan. +sshpass -p "$SSH_PASS" ssh $SSH_OPTS root@${APP_DOMAIN} "mkdir -p /data/navidrome/sample" +sshpass -p "$SSH_PASS" scp $SSH_OPTS "${DIR}/fixtures/sample.mp3" "root@${APP_DOMAIN}:/data/navidrome/sample/song.mp3" +sshpass -p "$SSH_PASS" ssh $SSH_OPTS root@${APP_DOMAIN} "chown -R navidrome /data/navidrome && snap restart navidrome.navidrome" +sshpass -p "$SSH_PASS" ssh $SSH_OPTS root@${APP_DOMAIN} "for i in \$(seq 1 60); do test -S /var/snap/navidrome/current/navidrome.sock && exit 0; sleep 2; done; exit 1" + +cd ${DIR} +npm install --no-audit --no-fund +npx playwright test --project="${PROJECT}" diff --git a/web/e2e/fixtures/sample.mp3 b/web/e2e/fixtures/sample.mp3 new file mode 100644 index 0000000..febde4a Binary files /dev/null and b/web/e2e/fixtures/sample.mp3 differ diff --git a/web/e2e/helpers/auth.ts b/web/e2e/helpers/auth.ts new file mode 100644 index 0000000..1acab9d --- /dev/null +++ b/web/e2e/helpers/auth.ts @@ -0,0 +1,14 @@ +import { Page } from '@playwright/test' + +export async function loginViaAuthelia (page: Page, baseURL: string, username: string, password: string) { + const appHost = new URL(baseURL).host + + await page.goto(baseURL) + await page.waitForURL((url) => url.host.startsWith('auth.')) + + await page.locator('input#username-textfield').fill(username) + await page.locator('input#password-textfield').fill(password) + await page.locator('button#sign-in-button').click() + + await page.waitForURL((url) => url.host === appHost) +} diff --git a/web/e2e/helpers/screenshot.ts b/web/e2e/helpers/screenshot.ts new file mode 100644 index 0000000..a11d6a9 --- /dev/null +++ b/web/e2e/helpers/screenshot.ts @@ -0,0 +1,6 @@ +import { Page, TestInfo } from '@playwright/test' + +export async function shoot (page: Page, info: TestInfo, name: string) { + await page.waitForTimeout(500) + await page.screenshot({ path: info.outputPath(`${name}.png`), fullPage: false }) +} diff --git a/web/e2e/package.json b/web/e2e/package.json new file mode 100644 index 0000000..4a305f2 --- /dev/null +++ b/web/e2e/package.json @@ -0,0 +1,13 @@ +{ + "name": "navidrome-e2e", + "version": "0.1.0", + "private": true, + "type": "module", + "scripts": { + "test": "playwright test" + }, + "devDependencies": { + "@playwright/test": "1.59.1", + "typescript": "^5.4.0" + } +} diff --git a/web/e2e/playwright.config.ts b/web/e2e/playwright.config.ts new file mode 100644 index 0000000..caa3f51 --- /dev/null +++ b/web/e2e/playwright.config.ts @@ -0,0 +1,22 @@ +import { defineConfig, devices } from '@playwright/test' + +const baseURL = `https://navidrome.${process.env.PLAYWRIGHT_DOMAIN}` + +export default defineConfig({ + testDir: './specs', + timeout: 120_000, + expect: { timeout: 20_000 }, + workers: 1, + retries: process.env.CI ? 1 : 0, + reporter: [['list']], + use: { + baseURL, + ignoreHTTPSErrors: true, + trace: 'retain-on-failure', + screenshot: 'only-on-failure', + video: 'on' + }, + projects: [ + { name: 'desktop', use: { ...devices['Desktop Chrome'], baseURL, ignoreHTTPSErrors: true } } + ] +}) diff --git a/web/e2e/specs/01-navidrome.spec.ts b/web/e2e/specs/01-navidrome.spec.ts new file mode 100644 index 0000000..123c926 --- /dev/null +++ b/web/e2e/specs/01-navidrome.spec.ts @@ -0,0 +1,12 @@ +import { test, expect } from '@playwright/test' +import { shoot } from '../helpers/screenshot' +import { loginViaAuthelia } from '../helpers/auth' + +const username = process.env.PLAYWRIGHT_USER! +const password = process.env.PLAYWRIGHT_PASSWORD! + +test('logs in via Syncloud SSO and lands in Navidrome', async ({ page, baseURL }, info) => { + await loginViaAuthelia(page, baseURL!, username, password) + await expect(page).toHaveTitle(/navidrome/i, { timeout: 45_000 }) + await shoot(page, info, 'navidrome-home') +}) diff --git a/web/e2e/specs/02-play.spec.ts b/web/e2e/specs/02-play.spec.ts new file mode 100644 index 0000000..cbe694a --- /dev/null +++ b/web/e2e/specs/02-play.spec.ts @@ -0,0 +1,41 @@ +import { test, expect } from '@playwright/test' +import { shoot } from '../helpers/screenshot' +import { loginViaAuthelia } from '../helpers/auth' + +const username = process.env.PLAYWRIGHT_USER! +const password = process.env.PLAYWRIGHT_PASSWORD! + +const album = 'Syncloud Test Album' +const song = 'Syncloud Test Song' + +test('log in, find the scanned album, open it and play the song', async ({ page, baseURL }, info) => { + await loginViaAuthelia(page, baseURL!, username, password) + await expect(page).toHaveTitle(/navidrome/i, { timeout: 45_000 }) + await shoot(page, info, '01-logged-in') + + // The album shows up once Navidrome has scanned the library (give the scan time). + const albumTile = page.getByText(album, { exact: false }).first() + await expect(albumTile).toBeVisible({ timeout: 120_000 }) + await shoot(page, info, '02-album-scanned') + + await albumTile.click() + const songRow = page.getByText(song, { exact: false }).first() + await expect(songRow).toBeVisible({ timeout: 30_000 }) + await shoot(page, info, '03-album-opened') + + // Clicking a song row plays it (Navidrome rowClick -> playTracks). + await songRow.click() + + // The player shows the now-playing title. + await expect(page.locator('.songTitle').first()).toContainText(song, { timeout: 30_000 }) + await shoot(page, info, '04-now-playing') + + // The audio actually progresses, i.e. /rest/stream works through the auth proxy. + await expect.poll(async () => { + return await page.evaluate(() => { + const a = document.querySelector('audio') as HTMLAudioElement | null + return a ? a.currentTime : -1 + }) + }, { timeout: 30_000, intervals: [1000] }).toBeGreaterThan(0) + await shoot(page, info, '05-audio-progressing') +}) diff --git a/web/e2e/tsconfig.json b/web/e2e/tsconfig.json new file mode 100644 index 0000000..5ca48bf --- /dev/null +++ b/web/e2e/tsconfig.json @@ -0,0 +1,11 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "ESNext", + "moduleResolution": "Bundler", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true + }, + "include": ["**/*.ts"] +}