From 6a3821711372cea40ee3bc6b5c5ca4479cfaada3 Mon Sep 17 00:00:00 2001 From: Bethuel Mmbaga Date: Wed, 7 Oct 2026 18:39:25 +0300 Subject: [PATCH] [management] Add a MySQL to Postgres migration tool (#8095) --- .../workflows/check-license-dependencies.yml | 4 +- .goreleaser.yaml | 26 + tools/mysql-migrate/LICENSE | 661 ++++++++++++++++++ tools/mysql-migrate/copy.go | 357 ++++++++++ tools/mysql-migrate/main.go | 242 +++++++ tools/mysql-migrate/main_test.go | 225 ++++++ 6 files changed, 1513 insertions(+), 2 deletions(-) create mode 100644 tools/mysql-migrate/LICENSE create mode 100644 tools/mysql-migrate/copy.go create mode 100644 tools/mysql-migrate/main.go create mode 100644 tools/mysql-migrate/main_test.go diff --git a/.github/workflows/check-license-dependencies.yml b/.github/workflows/check-license-dependencies.yml index 81d293e4f..27c59f8d6 100644 --- a/.github/workflows/check-license-dependencies.yml +++ b/.github/workflows/check-license-dependencies.yml @@ -34,7 +34,7 @@ jobs: while IFS= read -r dir; do echo "=== Checking $dir ===" # Search for problematic imports, excluding test files - RESULTS=$(grep -r "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\)" "$dir" --include="*.go" 2>/dev/null | grep -v "_test.go" | grep -v "test_" | grep -v "/test/" | grep -v "tools/idp-migrate/" || true) + RESULTS=$(grep -r "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\)" "$dir" --include="*.go" 2>/dev/null | grep -v "_test.go" | grep -v "test_" | grep -v "/test/" | grep -v "tools/idp-migrate/" | grep -v "tools/mysql-migrate/" || true) if [ -n "$RESULTS" ]; then echo "❌ Found problematic dependencies:" echo "$RESULTS" @@ -93,7 +93,7 @@ jobs: IMPORTERS=$(go list -json -deps ./... 2>/dev/null | jq -r "select(.Imports[]? == \"$package\") | .ImportPath") # Check if any importer is NOT in management/signal/relay - BSD_IMPORTER=$(echo "$IMPORTERS" | grep -v "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\|combined\|tools/idp-migrate\)" | head -1) + BSD_IMPORTER=$(echo "$IMPORTERS" | grep -v "github.com/netbirdio/netbird/\(management\|signal\|relay\|proxy\|combined\|tools/idp-migrate\|tools/mysql-migrate\)" | head -1) if [ -n "$BSD_IMPORTER" ]; then echo "❌ $package ($license) is imported by BSD-licensed code: $BSD_IMPORTER" diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 59d8274e9..0e9b11bc5 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -216,6 +216,28 @@ builds: - -s -w -X github.com/netbirdio/netbird/version.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}} -X main.builtBy=goreleaser mod_timestamp: "{{ .CommitTimestamp }}" + - id: netbird-mysql-migrate + dir: tools/mysql-migrate + env: + - CGO_ENABLED=1 + - >- + {{- if eq .Runtime.Goos "linux" }} + {{- if eq .Arch "arm64"}}CC=aarch64-linux-gnu-gcc{{- end }} + {{- if eq .Arch "arm"}}CC=arm-linux-gnueabihf-gcc{{- end }} + {{- end }} + binary: netbird-mysql-migrate + goos: + - linux + goarch: + - amd64 + - arm64 + - arm + goarm: + - 7 + ldflags: + - -s -w -X github.com/netbirdio/netbird/version.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}} -X main.builtBy=goreleaser + mod_timestamp: "{{ .CommitTimestamp }}" + universal_binaries: - id: netbird @@ -232,6 +254,10 @@ archives: builds: - netbird-idp-migrate name_template: "netbird-idp-migrate_{{ .Version }}_{{ .Os }}_{{ .Arch }}" + - id: netbird-mysql-migrate + builds: + - netbird-mysql-migrate + name_template: "netbird-mysql-migrate_{{ .Version }}_{{ .Os }}_{{ .Arch }}" nfpms: - maintainer: Netbird diff --git a/tools/mysql-migrate/LICENSE b/tools/mysql-migrate/LICENSE new file mode 100644 index 000000000..be3f7b28e --- /dev/null +++ b/tools/mysql-migrate/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/tools/mysql-migrate/copy.go b/tools/mysql-migrate/copy.go new file mode 100644 index 000000000..85e0c5e91 --- /dev/null +++ b/tools/mysql-migrate/copy.go @@ -0,0 +1,357 @@ +package main + +import ( + "context" + "database/sql" + "fmt" + "math" + "slices" + "strconv" + "strings" + + "github.com/jackc/pgx/v5" + "github.com/jackc/pgx/v5/pgtype" +) + +type dialect struct { + quote func(string) string + tablesQuery string + columnsQuery string +} + +var mysqlDialect = dialect{ + quote: func(name string) string { return "`" + name + "`" }, + tablesQuery: `SELECT table_name FROM information_schema.tables WHERE table_schema = DATABASE() AND table_type = 'BASE TABLE'`, + columnsQuery: `SELECT column_name FROM information_schema.columns WHERE table_schema = DATABASE() AND table_name = ?`, +} + +var sqliteDialect = dialect{ + quote: func(name string) string { return `"` + name + `"` }, + tablesQuery: `SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT LIKE 'sqlite_%'`, + columnsQuery: `SELECT name FROM pragma_table_info(?)`, +} + +type column struct { + name string + pgType string +} + +// copyStore copies the tables the source shares with the target schema; +// source-only tables are legacy and skipped. +func copyStore(ctx context.Context, src *sql.DB, d dialect, tx pgx.Tx, skip map[string]bool) (int, int64, error) { + srcTables, err := queryStrings(ctx, src, d.tablesQuery) + if err != nil { + return 0, 0, fmt.Errorf("list source tables: %w", err) + } + dstTables, err := pgStrings(ctx, tx, `SELECT table_name FROM information_schema.tables WHERE table_schema = current_schema() AND table_type = 'BASE TABLE'`) + if err != nil { + return 0, 0, fmt.Errorf("list target tables: %w", err) + } + + var tables []string + for _, t := range srcTables { + if !skip[t] && slices.Contains(dstTables, t) { + tables = append(tables, t) + } + } + if len(tables) == 0 { + return 0, 0, fmt.Errorf("no NetBird tables found in the source") + } + + ordered, err := parentsFirst(ctx, tx, tables) + if err != nil { + return 0, 0, err + } + + var total int64 + for _, table := range ordered { + n, err := copyTable(ctx, src, d, tx, table) + if err != nil { + return 0, 0, fmt.Errorf("table %s: %w", table, err) + } + total += n + } + + if err := resetSequences(ctx, tx, tables); err != nil { + return 0, 0, err + } + return len(tables), total, nil +} + +func copyTable(ctx context.Context, src *sql.DB, d dialect, tx pgx.Tx, table string) (int64, error) { + cols, err := targetColumns(ctx, tx, table) + if err != nil { + return 0, err + } + srcCols, err := queryStrings(ctx, src, d.columnsQuery, table) + if err != nil { + return 0, fmt.Errorf("list source columns: %w", err) + } + + names := make([]string, len(cols)) + quoted := make([]string, len(cols)) + var missing []string + for i, c := range cols { + names[i] = c.name + quoted[i] = d.quote(c.name) + if !slices.Contains(srcCols, c.name) { + missing = append(missing, c.name) + } + } + if len(missing) > 0 { + return 0, fmt.Errorf("source lacks columns %v; start the management server once with this release before migrating", missing) + } + + var hasRows bool + if err := tx.QueryRow(ctx, fmt.Sprintf("SELECT EXISTS (SELECT 1 FROM %s)", pgx.Identifier{table}.Sanitize())).Scan(&hasRows); err != nil { + return 0, err + } + if hasRows { + return 0, fmt.Errorf("target already holds data") + } + + rows, err := src.QueryContext(ctx, fmt.Sprintf("SELECT %s FROM %s", strings.Join(quoted, ", "), d.quote(table))) + if err != nil { + return 0, fmt.Errorf("read source: %w", err) + } + defer rows.Close() + + return tx.CopyFrom(ctx, pgx.Identifier{table}, names, newRowSource(rows, cols)) +} + +func targetColumns(ctx context.Context, tx pgx.Tx, table string) ([]column, error) { + rows, err := tx.Query(ctx, `SELECT column_name, data_type FROM information_schema.columns + WHERE table_schema = current_schema() AND table_name = $1 ORDER BY ordinal_position`, table) + if err != nil { + return nil, err + } + return pgx.CollectRows(rows, func(row pgx.CollectableRow) (column, error) { + var c column + err := row.Scan(&c.name, &c.pgType) + return c, err + }) +} + +func parentsFirst(ctx context.Context, tx pgx.Tx, tables []string) ([]string, error) { + rows, err := tx.Query(ctx, `SELECT child.relname, parent.relname FROM pg_constraint c + JOIN pg_class child ON child.oid = c.conrelid + JOIN pg_class parent ON parent.oid = c.confrelid + JOIN pg_namespace n ON n.oid = child.relnamespace + WHERE c.contype = 'f' AND n.nspname = current_schema()`) + if err != nil { + return nil, fmt.Errorf("read foreign keys: %w", err) + } + parents := map[string][]string{} + var child, parent string + _, err = pgx.ForEachRow(rows, []any{&child, &parent}, func() error { + if child != parent { + parents[child] = append(parents[child], parent) + } + return nil + }) + if err != nil { + return nil, fmt.Errorf("read foreign keys: %w", err) + } + + pending := slices.Sorted(slices.Values(tables)) + done := make(map[string]bool, len(tables)) + ordered := make([]string, 0, len(tables)) + for len(pending) > 0 { + var next []string + for _, t := range pending { + if ready(parents[t], tables, done) { + ordered = append(ordered, t) + done[t] = true + } else { + next = append(next, t) + } + } + if len(next) == len(pending) { + return nil, fmt.Errorf("foreign keys form a cycle between %v", next) + } + pending = next + } + return ordered, nil +} + +func ready(parents, tables []string, done map[string]bool) bool { + for _, p := range parents { + if slices.Contains(tables, p) && !done[p] { + return false + } + } + return true +} + +// resetSequences moves serial sequences past the ids COPY inserted explicitly. +func resetSequences(ctx context.Context, tx pgx.Tx, tables []string) error { + rows, err := tx.Query(ctx, `SELECT table_name, column_name, pg_get_serial_sequence(quote_ident(table_name), column_name) + FROM information_schema.columns + WHERE table_schema = current_schema() AND table_name = ANY($1) + AND pg_get_serial_sequence(quote_ident(table_name), column_name) IS NOT NULL`, tables) + if err != nil { + return fmt.Errorf("list sequences: %w", err) + } + type sequence struct{ table, column, name string } + seqs, err := pgx.CollectRows(rows, func(row pgx.CollectableRow) (sequence, error) { + var s sequence + err := row.Scan(&s.table, &s.column, &s.name) + return s, err + }) + if err != nil { + return fmt.Errorf("list sequences: %w", err) + } + + for _, s := range seqs { + q := fmt.Sprintf("SELECT setval('%s', COALESCE(MAX(%s), 0) + 1, false) FROM %s", + strings.ReplaceAll(s.name, "'", "''"), pgx.Identifier{s.column}.Sanitize(), pgx.Identifier{s.table}.Sanitize()) + if _, err := tx.Exec(ctx, q); err != nil { + return fmt.Errorf("reset sequence %s: %w", s.name, err) + } + } + return nil +} + +type rowSource struct { + rows *sql.Rows + cols []column + vals []any + ptrs []any +} + +func newRowSource(rows *sql.Rows, cols []column) *rowSource { + r := &rowSource{rows: rows, cols: cols, vals: make([]any, len(cols)), ptrs: make([]any, len(cols))} + for i := range r.vals { + r.ptrs[i] = &r.vals[i] + } + return r +} + +func (r *rowSource) Next() bool { return r.rows.Next() } + +func (r *rowSource) Err() error { return r.rows.Err() } + +func (r *rowSource) Values() ([]any, error) { + if err := r.rows.Scan(r.ptrs...); err != nil { + return nil, err + } + out := make([]any, len(r.vals)) + for i, v := range r.vals { + if v == nil { + continue + } + converted, err := convert(v, r.cols[i].pgType) + if err != nil { + return nil, fmt.Errorf("column %s: %w", r.cols[i].name, err) + } + out[i] = converted + } + return out, nil +} + +// convert adapts a non-NULL value to the target column type: MySQL and SQLite +// return text and numbers as bytes and booleans as integers. +func convert(v any, pgType string) (any, error) { + switch pgType { + case "boolean": + return toBool(v) + case "bytea": + return toBytes(v), nil + case "smallint", "integer", "bigint": + return toInt64(v) + case "real", "double precision": + return toFloat64(v) + case "numeric": + return toNumeric(v) + default: + return toText(v), nil + } +} + +func toBool(v any) (any, error) { + switch b := v.(type) { + case int64: + return b != 0, nil + case []byte: + return strconv.ParseBool(string(b)) + case string: + return strconv.ParseBool(b) + } + return v, nil +} + +func toBytes(v any) any { + if s, ok := v.(string); ok { + return []byte(s) + } + return v +} + +func toInt64(v any) (any, error) { + switch n := v.(type) { + case uint64: + if n > math.MaxInt64 { + return nil, fmt.Errorf("value %d overflows bigint", n) + } + return int64(n), nil + case []byte: + return strconv.ParseInt(string(n), 10, 64) + } + return v, nil +} + +func toFloat64(v any) (any, error) { + if b, ok := v.([]byte); ok { + return strconv.ParseFloat(string(b), 64) + } + return v, nil +} + +func toNumeric(v any) (any, error) { + var s string + switch x := v.(type) { + case []byte: + s = string(x) + case string: + s = x + default: + return v, nil + } + var n pgtype.Numeric + if err := n.Scan(s); err != nil { + return nil, err + } + return n, nil +} + +func toText(v any) any { + if b, ok := v.([]byte); ok { + return string(b) + } + return v +} + +func queryStrings(ctx context.Context, db *sql.DB, query string, args ...any) ([]string, error) { + rows, err := db.QueryContext(ctx, query, args...) + if err != nil { + return nil, err + } + defer rows.Close() + var out []string + for rows.Next() { + var s string + if err := rows.Scan(&s); err != nil { + return nil, err + } + out = append(out, s) + } + return out, rows.Err() +} + +func pgStrings(ctx context.Context, tx pgx.Tx, query string) ([]string, error) { + rows, err := tx.Query(ctx, query) + if err != nil { + return nil, err + } + return pgx.CollectRows(rows, pgx.RowTo[string]) +} diff --git a/tools/mysql-migrate/main.go b/tools/mysql-migrate/main.go new file mode 100644 index 000000000..f9531c66a --- /dev/null +++ b/tools/mysql-migrate/main.go @@ -0,0 +1,242 @@ +package main + +import ( + "context" + "database/sql" + "errors" + "flag" + "fmt" + "log/slog" + "net/url" + "os" + "strings" + "time" + + "github.com/jackc/pgx/v5" + "github.com/jackc/pgx/v5/pgxpool" + log "github.com/sirupsen/logrus" + "gorm.io/driver/mysql" + "gorm.io/driver/postgres" + "gorm.io/driver/sqlite" + "gorm.io/gorm" + "gorm.io/gorm/logger" + + "github.com/netbirdio/netbird/idp/dex" + "github.com/netbirdio/netbird/management/internals/shared/db" + "github.com/netbirdio/netbird/management/server/activity" + "github.com/netbirdio/netbird/management/server/store" +) + +type config struct { + mysqlDSN string + postgresDSN string + eventsPostgresDSN string + authPostgresDSN string + eventsDB string + authDB string + mysqlTimezone string +} + +type storeMigration struct { + name string + source *sql.DB + dialect dialect + targetDSN string + schema func(ctx context.Context, dsn string) error + skipTables map[string]bool +} + +func main() { + cfg, err := parseFlags(os.Args[1:]) + if errors.Is(err, flag.ErrHelp) { + return + } + if err != nil { + fmt.Fprintln(os.Stderr, err) + os.Exit(2) + } + + // Silence the store constructors' migration logs. + log.SetLevel(log.WarnLevel) + + if err := run(context.Background(), cfg); err != nil { + fmt.Fprintf(os.Stderr, "migration failed: %v\n", err) + os.Exit(1) + } +} + +func parseFlags(args []string) (*config, error) { + cfg := &config{} + fs := flag.NewFlagSet("netbird-mysql-migrate", flag.ContinueOnError) + fs.StringVar(&cfg.mysqlDSN, "mysql-dsn", "", "MySQL DSN of the management store (required)") + fs.StringVar(&cfg.postgresDSN, "postgres-dsn", "", "Postgres DSN to migrate all stores to (required)") + fs.StringVar(&cfg.eventsPostgresDSN, "events-postgres-dsn", "", "Postgres DSN for activity events (default --postgres-dsn)") + fs.StringVar(&cfg.authPostgresDSN, "auth-postgres-dsn", "", "Postgres DSN for the embedded IdP (default --postgres-dsn)") + fs.StringVar(&cfg.eventsDB, "events-db", "/var/lib/netbird/events.db", "SQLite file of the activity events, skipped when missing") + fs.StringVar(&cfg.authDB, "auth-db", "/var/lib/netbird/idp.db", "SQLite file of the embedded IdP, skipped when missing") + fs.StringVar(&cfg.mysqlTimezone, "mysql-timezone", "UTC", "time zone the management server ran in, e.g. Europe/Berlin") + if err := fs.Parse(args); err != nil { + return nil, err + } + if _, err := time.LoadLocation(cfg.mysqlTimezone); err != nil { + return nil, fmt.Errorf("--mysql-timezone: %w", err) + } + + if cfg.mysqlDSN == "" || cfg.postgresDSN == "" { + return nil, errors.New("--mysql-dsn and --postgres-dsn are required") + } + if cfg.eventsPostgresDSN == "" { + cfg.eventsPostgresDSN = cfg.postgresDSN + } + if cfg.authPostgresDSN == "" { + cfg.authPostgresDSN = cfg.postgresDSN + } + return cfg, nil +} + +func run(ctx context.Context, cfg *config) error { + migrations, closeSources, err := openSources(cfg) + if err != nil { + return err + } + defer closeSources() + + for _, m := range migrations { + if err := m.schema(ctx, m.targetDSN); err != nil { + return fmt.Errorf("create %s schema: %w", m.name, err) + } + } + + var ( + pools []*pgxpool.Pool + txs []pgx.Tx + ) + // Roll back first: pool Close waits for the connections open transactions hold. + defer func() { + for _, tx := range txs { + _ = tx.Rollback(ctx) + } + for _, pool := range pools { + pool.Close() + } + }() + + results := make([]string, 0, len(migrations)) + for _, m := range migrations { + pool, err := pgxpool.New(ctx, m.targetDSN) + if err != nil { + return fmt.Errorf("connect %s target: %w", m.name, err) + } + pools = append(pools, pool) + + tx, err := pool.Begin(ctx) + if err != nil { + return fmt.Errorf("begin %s transaction: %w", m.name, err) + } + txs = append(txs, tx) + + tables, rows, err := copyStore(ctx, m.source, m.dialect, tx, m.skipTables) + if err != nil { + return fmt.Errorf("%s: %w", m.name, err) + } + results = append(results, fmt.Sprintf("%s: %d rows from %d tables", m.name, rows, tables)) + } + + // Commit last so a failure in any store leaves every target empty. + for i, tx := range txs { + if err := tx.Commit(ctx); err != nil { + return fmt.Errorf("commit %s: %w", migrations[i].name, err) + } + } + + for _, r := range results { + fmt.Fprintln(os.Stdout, r) + } + fmt.Fprintln(os.Stdout, "Done. Point the store, activity and auth store settings at Postgres before starting the server.") + return nil +} + +func openSources(cfg *config) ([]storeMigration, func(), error) { + var opened []*gorm.DB + closeAll := func() { + for _, g := range opened { + if sqlDB, err := g.DB(); err == nil { + _ = sqlDB.Close() + } + } + } + + open := func(dialector gorm.Dialector) (*sql.DB, error) { + g, err := gorm.Open(dialector, &gorm.Config{Logger: logger.Discard}) + if err != nil { + return nil, err + } + opened = append(opened, g) + return g.DB() + } + + mysqlDB, err := open(mysql.Open(mysqlDSN(cfg.mysqlDSN, cfg.mysqlTimezone))) + if err != nil { + closeAll() + return nil, nil, fmt.Errorf("open MySQL: %w", err) + } + migrations := []storeMigration{{ + name: "management", source: mysqlDB, dialect: mysqlDialect, + targetDSN: cfg.postgresDSN, schema: createManagementSchema, + }} + + sqliteStores := []storeMigration{ + {name: "activity", targetDSN: cfg.eventsPostgresDSN, schema: createActivitySchema}, + {name: "auth", targetDSN: cfg.authPostgresDSN, schema: createAuthSchema, skipTables: map[string]bool{"migrations": true}}, + } + for i, file := range []string{cfg.eventsDB, cfg.authDB} { + m := sqliteStores[i] + if _, err := os.Stat(file); errors.Is(err, os.ErrNotExist) { + fmt.Fprintf(os.Stdout, "%s: %s not found, skipping\n", m.name, file) + continue + } + m.source, err = open(sqlite.Open("file:" + file + "?mode=ro")) + if err != nil { + closeAll() + return nil, nil, fmt.Errorf("open %s: %w", file, err) + } + m.dialect = sqliteDialect + migrations = append(migrations, m) + } + + return migrations, closeAll, nil +} + +func mysqlDSN(dsn, timezone string) string { + return strings.TrimSuffix(db.MysqlDSN(dsn), "&loc=Local") + "&loc=" + url.QueryEscape(timezone) +} + +func createManagementSchema(ctx context.Context, dsn string) error { + s, err := store.NewPostgresqlStore(ctx, dsn, nil, false) + if err != nil { + return err + } + return s.Close(ctx) +} + +func createActivitySchema(_ context.Context, dsn string) error { + g, err := gorm.Open(postgres.Open(dsn), &gorm.Config{Logger: logger.Discard}) + if err != nil { + return err + } + defer func() { + if sqlDB, err := g.DB(); err == nil { + _ = sqlDB.Close() + } + }() + return g.AutoMigrate(&activity.Event{}, &activity.DeletedUser{}) +} + +func createAuthSchema(_ context.Context, dsn string) error { + cfg := dex.Storage{Type: "postgres", Config: map[string]any{"dsn": dsn}} + s, err := cfg.OpenStorage(slog.New(slog.DiscardHandler)) + if err != nil { + return err + } + return s.Close() +} diff --git a/tools/mysql-migrate/main_test.go b/tools/mysql-migrate/main_test.go new file mode 100644 index 000000000..c80fc6e4c --- /dev/null +++ b/tools/mysql-migrate/main_test.go @@ -0,0 +1,225 @@ +package main + +import ( + "context" + "encoding/json" + "log/slog" + "os" + "path/filepath" + "runtime" + "strings" + "testing" + "time" + + dexstorage "github.com/dexidp/dex/storage" + "github.com/jackc/pgx/v5/pgxpool" + "github.com/rs/xid" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "gorm.io/driver/mysql" + "gorm.io/gorm" + + "github.com/netbirdio/netbird/idp/dex" + "github.com/netbirdio/netbird/management/internals/shared/db" + "github.com/netbirdio/netbird/management/server/activity" + activitystore "github.com/netbirdio/netbird/management/server/activity/store" + "github.com/netbirdio/netbird/management/server/store" + "github.com/netbirdio/netbird/management/server/testutil" + "github.com/netbirdio/netbird/management/server/types" + "github.com/netbirdio/netbird/util/crypt" +) + +const testAccountID = "bf1c8084-ba50-4ce7-9439-34653001fc3b" + +func TestRun(t *testing.T) { + if os.Getenv("CI") == "true" && runtime.GOOS != "linux" { + t.Skip("needs Docker for the MySQL and Postgres containers") + } + // Seed in UTC to match the --mysql-timezone default. + time.Local = time.UTC + ctx := context.Background() + dir := t.TempDir() + key, err := crypt.GenerateKey() + require.NoError(t, err) + + mysqlDSN := newMySQLDatabase(t, "run_src") + pgDSN := newPostgresDatabase(t, ctx, "run_dst") + mysqlStore := seedMySQL(t, ctx, mysqlDSN) + eventID := seedEvents(t, ctx, dir, key) + seedIdP(t, ctx, filepath.Join(dir, "idp.db")) + + cfg, err := parseFlags([]string{ + "--mysql-dsn", mysqlDSN, + "--postgres-dsn", pgDSN, + "--events-db", filepath.Join(dir, "events.db"), + "--auth-db", filepath.Join(dir, "idp.db"), + }) + require.NoError(t, err) + require.NoError(t, run(ctx, cfg)) + + t.Run("management", func(t *testing.T) { + pgStore, err := store.NewPostgresqlStore(ctx, pgDSN, nil, true) + require.NoError(t, err) + t.Cleanup(func() { _ = pgStore.Close(ctx) }) + + assert.JSONEq(t, accountJSON(t, ctx, mysqlStore), accountJSON(t, ctx, pgStore), + "the account read from Postgres must match the one in MySQL") + }) + + t.Run("activity", func(t *testing.T) { + t.Setenv("NB_ACTIVITY_EVENT_STORE_ENGINE", "postgres") + t.Setenv("NB_ACTIVITY_EVENT_POSTGRES_DSN", pgDSN) + events, err := activitystore.NewSqlStore(ctx, dir, key) + require.NoError(t, err) + t.Cleanup(func() { _ = events.Close(ctx) }) + + got, err := events.Get(ctx, testAccountID, 0, 10, false) + require.NoError(t, err) + require.Len(t, got, 1, "the migrated event must be readable") + assert.Equal(t, eventID, got[0].ID, "the event must keep its id") + + next, err := events.Save(ctx, &activity.Event{Timestamp: time.Now(), AccountID: testAccountID, InitiatorID: "u", TargetID: "p"}) + require.NoError(t, err) + assert.Greater(t, next.ID, eventID, "new events must continue after the migrated ids") + }) + + t.Run("auth", func(t *testing.T) { + idp := dex.Storage{Type: "postgres", Config: map[string]any{"dsn": pgDSN}} + s, err := idp.OpenStorage(slog.New(slog.DiscardHandler)) + require.NoError(t, err) + t.Cleanup(func() { _ = s.Close() }) + + pw, err := s.GetPassword(ctx, "admin@example.com") + require.NoError(t, err) + assert.Equal(t, []byte("hash"), pw.Hash, "the IdP password must survive the migration") + }) + + t.Run("refuses a target that holds data", func(t *testing.T) { + assert.ErrorContains(t, run(ctx, cfg), "target already holds data") + }) +} + +func seedMySQL(t *testing.T, ctx context.Context, dsn string) *store.SqlStore { + t.Helper() + t.Setenv("NETBIRD_STORE_ENGINE", string(types.SqliteStoreEngine)) + seed, cleanup, err := store.NewTestStoreFromSQL(ctx, "../../management/server/testdata/extended-store.sql", t.TempDir()) + require.NoError(t, err) + t.Cleanup(cleanup) + + mysqlStore, err := store.NewMysqlStoreFromSqlStore(ctx, seed.(*store.SqlStore), dsn, nil) + require.NoError(t, err) + t.Cleanup(func() { _ = mysqlStore.Close(ctx) }) + return mysqlStore +} + +func seedEvents(t *testing.T, ctx context.Context, dir, key string) uint64 { + t.Helper() + events, err := activitystore.NewSqlStore(ctx, dir, key) + require.NoError(t, err) + defer events.Close(ctx) + + event, err := events.Save(ctx, &activity.Event{ + Timestamp: time.Now(), Activity: activity.PeerAddedByUser, + AccountID: testAccountID, InitiatorID: "user", TargetID: "peer", + Meta: map[string]any{"name": "peer"}, + }) + require.NoError(t, err) + return event.ID +} + +func seedIdP(t *testing.T, ctx context.Context, file string) { + t.Helper() + idp := dex.Storage{Type: "sqlite3", Config: map[string]any{"file": file}} + s, err := idp.OpenStorage(slog.New(slog.DiscardHandler)) + require.NoError(t, err) + defer s.Close() + + require.NoError(t, s.CreatePassword(ctx, dexstorage.Password{ + Email: "admin@example.com", Hash: []byte("hash"), Username: "admin", UserID: "admin-id", + })) +} + +func accountJSON(t *testing.T, ctx context.Context, s store.Store) string { + t.Helper() + var account *types.Account + require.NoError(t, s.ExecuteInTransaction(ctx, func(tx store.Store) error { + var err error + account, err = tx.GetAccount(ctx, testAccountID) + return err + })) + out, err := json.Marshal(account) + require.NoError(t, err) + return string(out) +} + +func TestMySQLTimezone(t *testing.T) { + if os.Getenv("CI") == "true" && runtime.GOOS != "linux" { + t.Skip("needs Docker for the MySQL and Postgres containers") + } + ctx := context.Background() + mysqlDSN := newMySQLDatabase(t, "tz_src") + pgDSN := newPostgresDatabase(t, ctx, "tz_dst") + ms := seedMySQL(t, ctx, mysqlDSN) + require.NoError(t, ms.GetDB().Exec("UPDATE accounts SET created_at = '2026-01-02 03:04:05' WHERE id = ?", testAccountID).Error) + + cfg, err := parseFlags([]string{ + "--mysql-dsn", mysqlDSN, + "--postgres-dsn", pgDSN, + "--mysql-timezone", "Asia/Tokyo", + "--events-db", filepath.Join(t.TempDir(), "none.db"), + "--auth-db", filepath.Join(t.TempDir(), "none.db"), + }) + require.NoError(t, err) + require.NoError(t, run(ctx, cfg)) + + pool, err := pgxpool.New(ctx, pgDSN) + require.NoError(t, err) + t.Cleanup(pool.Close) + var got time.Time + require.NoError(t, pool.QueryRow(ctx, "SELECT created_at FROM accounts WHERE id = $1", testAccountID).Scan(&got)) + want := time.Date(2026, 1, 1, 18, 4, 5, 0, time.UTC) + assert.True(t, want.Equal(got), "created_at must keep the instant the server wrote, got %s", got.UTC()) +} + +func TestParseFlagsRejectsUnknownTimezone(t *testing.T) { + _, err := parseFlags([]string{"--mysql-dsn", "m", "--postgres-dsn", "p", "--mysql-timezone", "Mars/Base"}) + assert.ErrorContains(t, err, "--mysql-timezone") +} + +// newMySQLDatabase creates a database unique to this run in the shared +// container, so repeated runs (-count) don't collide, and drops it afterwards. +func newMySQLDatabase(t *testing.T, prefix string) string { + t.Helper() + _, base, err := testutil.CreateMysqlTestContainer() + require.NoError(t, err) + admin, err := gorm.Open(mysql.Open(db.MysqlDSN(base)), &gorm.Config{}) + require.NoError(t, err) + name := prefix + "_" + xid.New().String() + require.NoError(t, admin.Exec("CREATE DATABASE "+name).Error) + t.Cleanup(func() { + _ = admin.Exec("DROP DATABASE IF EXISTS " + name).Error + if sqlDB, err := admin.DB(); err == nil { + _ = sqlDB.Close() + } + }) + return base[:strings.LastIndex(base, "/")] + "/" + name +} + +// newPostgresDatabase is the Postgres counterpart of newMySQLDatabase. +func newPostgresDatabase(t *testing.T, ctx context.Context, prefix string) string { + t.Helper() + _, base, err := testutil.CreatePostgresTestContainer() + require.NoError(t, err) + // Dex connects through lib/pq, which requires TLS unless told otherwise. + base = strings.TrimSuffix(base, "?") + admin, err := pgxpool.New(ctx, base+"?sslmode=disable") + require.NoError(t, err) + name := prefix + "_" + xid.New().String() + _, err = admin.Exec(ctx, "CREATE DATABASE "+name) + require.NoError(t, err) + t.Cleanup(func() { + _, _ = admin.Exec(context.Background(), "DROP DATABASE IF EXISTS "+name+" WITH (FORCE)") + admin.Close() + }) + return base[:strings.LastIndex(base, "/")] + "/" + name + "?sslmode=disable" +}