From 10031079fb78007a4d86b70ad0bfdd3991b2aecc Mon Sep 17 00:00:00 2001 From: Mattias Persson Date: Thu, 12 Nov 2015 16:35:48 +0100 Subject: [PATCH] Adds tool for building db from transaction logs of other db As part of this commit also introduces a generic ConsoleInput utility which should help building other tools as well. --- .../src/main/java/org/neo4j/helpers/Args.java | 59 +- .../resources/licensing-requirements-base.xml | 6 +- tools/LICENSES.txt | 720 ++++++++++++++++++ tools/NOTICE.txt | 9 + tools/pom.xml | 15 + .../applytx/ApplyTransactionsCommand.java | 182 +++++ .../tools/applytx/DatabaseRebuildTool.java | 247 ++++++ .../tools/applytx/DumpRecordsCommand.java | 231 ++++++ .../tools/console/input/ArgsCommand.java | 35 + .../neo4j/tools/console/input/Command.java | 30 + .../tools/console/input/ConsoleInput.java | 186 +++++ .../tools/console/input/ConsoleUtil.java | 148 ++++ .../org/neo4j/tools/txlog/CheckTxLogs.java | 2 +- .../applytx/DatabaseRebuildToolTest.java | 225 ++++++ 14 files changed, 2080 insertions(+), 15 deletions(-) create mode 100644 tools/src/main/java/org/neo4j/tools/applytx/ApplyTransactionsCommand.java create mode 100644 tools/src/main/java/org/neo4j/tools/applytx/DatabaseRebuildTool.java create mode 100644 tools/src/main/java/org/neo4j/tools/applytx/DumpRecordsCommand.java create mode 100644 tools/src/main/java/org/neo4j/tools/console/input/ArgsCommand.java create mode 100644 tools/src/main/java/org/neo4j/tools/console/input/Command.java create mode 100644 tools/src/main/java/org/neo4j/tools/console/input/ConsoleInput.java create mode 100644 tools/src/main/java/org/neo4j/tools/console/input/ConsoleUtil.java create mode 100644 tools/src/test/java/org/neo4j/tools/applytx/DatabaseRebuildToolTest.java diff --git a/community/kernel/src/main/java/org/neo4j/helpers/Args.java b/community/kernel/src/main/java/org/neo4j/helpers/Args.java index d943b74a6029c..afb03855715ba 100644 --- a/community/kernel/src/main/java/org/neo4j/helpers/Args.java +++ b/community/kernel/src/main/java/org/neo4j/helpers/Args.java @@ -249,29 +249,57 @@ public long getDuration( String key, long defaultValueInMillis) return value != null ? TimeUtil.parseTimeMillis.apply(value) : defaultValueInMillis; } - public Boolean getBoolean( String key, Boolean defaultValue ) + /** + * Like calling {@link #getBoolean(String, Boolean)} with {@code false} for default value. + * This is the most common case, i.e. returns {@code true} if boolean argument was specified as: + * + * Otherwise {@code false. + * } + * @param key argument key. + * @return {@code true} if argument was specified w/o value, or w/ value {@code true}, otherwise {@code false}. + */ + public boolean getBoolean( String key ) { - String value = getSingleOptionOrNull( key ); + return getBoolean( key, false ); + } - // Apparently this condition must be split like this, instead of as an elvis operator, - // because defaultValue will, in that case, be evaluated as a primitive boolean and - // a NullPointerException will insue. Odd. - if ( value != null ) - { - return Boolean.parseBoolean( value ); - } - return defaultValue; + /** + * Like calling {@link #getBoolean(String, Boolean, Boolean)} with {@code true} for + * {@code defaultValueIfNoValue}, i.e. specifying {@code --myarg} will interpret it as {@code true}. + */ + public Boolean getBoolean( String key, Boolean defaultValueIfNotSpecified ) + { + return getBoolean( key, defaultValueIfNotSpecified, Boolean.TRUE ); } - public Boolean getBoolean( String key, Boolean defaultValueIfNotFound, - Boolean defaultValueIfNoValue ) + /** + * Parses a {@code boolean} argument. There are a couple of cases: + * + * + * @param key argument key. + * @param defaultValueIfNotSpecified used if argument not specified. + * @param defaultValueIfSpecifiedButNoValue used if argument specified w/o value. + * @return argument boolean value depending on what was specified, see above. + */ + public Boolean getBoolean( String key, Boolean defaultValueIfNotSpecified, + Boolean defaultValueIfSpecifiedButNoValue ) { String value = getSingleOptionOrNull( key ); if ( value != null ) { return Boolean.parseBoolean( value ); } - return this.map.containsKey( key ) ? defaultValueIfNoValue : defaultValueIfNotFound; + return this.map.containsKey( key ) ? defaultValueIfSpecifiedButNoValue : defaultValueIfNotSpecified; } public > T getEnum( Class enumClass, String key, T defaultValue ) @@ -297,6 +325,11 @@ public List orphans() return new ArrayList<>( this.orphans ); } + public String[] orphansAsArray() + { + return orphans.toArray( new String[orphans.size()] ); + } + public String[] asArgs() { List list = new ArrayList<>(); diff --git a/community/licensecheck-config/src/main/resources/licensing-requirements-base.xml b/community/licensecheck-config/src/main/resources/licensing-requirements-base.xml index 1a2ec493074f5..e693116324764 100644 --- a/community/licensecheck-config/src/main/resources/licensing-requirements-base.xml +++ b/community/licensecheck-config/src/main/resources/licensing-requirements-base.xml @@ -77,6 +77,9 @@ CDDL1.1 GPL2/CPE + + LGPL2.1 + @@ -95,6 +98,7 @@ Apache Software Licenses Apache 2 Apache License, Version 2.0 + Apache License 2.0 BSD @@ -147,6 +151,6 @@ - + diff --git a/tools/LICENSES.txt b/tools/LICENSES.txt index e62824d7096a5..b94d185fefcd3 100644 --- a/tools/LICENSES.txt +++ b/tools/LICENSES.txt @@ -1,4 +1,724 @@ This file contains the full license text of the included third party libraries. For an overview of the licenses see the NOTICE.txt file. +------------------------------------------------------------------------------ +Apache Software License, Version 2.0 + airline + Guava: Google Core Libraries for Java + javax.inject + Lucene Core +------------------------------------------------------------------------------ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +------------------------------------------------------------------------------ +GNU Lesser General Public License, Version 2.1 + FindBugs-Annotations +------------------------------------------------------------------------------ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/tools/NOTICE.txt b/tools/NOTICE.txt index edeb6ad15811d..b888ef8aa8db7 100644 --- a/tools/NOTICE.txt +++ b/tools/NOTICE.txt @@ -24,3 +24,12 @@ Full license texts are found in LICENSES.txt. Third-party licenses -------------------- +Apache Software License, Version 2.0 + airline + Guava: Google Core Libraries for Java + javax.inject + Lucene Core + +GNU Lesser General Public License, Version 2.1 + FindBugs-Annotations + diff --git a/tools/pom.xml b/tools/pom.xml index affdaaeb25771..546bef70b99a7 100644 --- a/tools/pom.xml +++ b/tools/pom.xml @@ -43,6 +43,7 @@ + org.neo4j neo4j-kernel @@ -60,6 +61,20 @@ ${project.version} test-jar + + org.neo4j + neo4j-consistency-check + ${project.version} + + + + + io.airlift + airline + 0.7 + + + junit junit diff --git a/tools/src/main/java/org/neo4j/tools/applytx/ApplyTransactionsCommand.java b/tools/src/main/java/org/neo4j/tools/applytx/ApplyTransactionsCommand.java new file mode 100644 index 0000000000000..7aeee8f78b8fa --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/applytx/ApplyTransactionsCommand.java @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.applytx; + +import java.io.File; +import java.io.IOException; +import java.io.PrintStream; + +import org.neo4j.graphdb.DependencyResolver; +import org.neo4j.helpers.Args; +import org.neo4j.helpers.ArrayUtil; +import org.neo4j.helpers.Provider; +import org.neo4j.helpers.progress.ProgressListener; +import org.neo4j.io.fs.DefaultFileSystemAbstraction; +import org.neo4j.io.pagecache.PageCache; +import org.neo4j.kernel.GraphDatabaseAPI; +import org.neo4j.kernel.KernelHealth; +import org.neo4j.kernel.api.exceptions.TransactionFailureException; +import org.neo4j.kernel.api.labelscan.LabelScanStore; +import org.neo4j.kernel.impl.api.BatchingTransactionRepresentationStoreApplier; +import org.neo4j.kernel.impl.api.LegacyIndexApplierLookup; +import org.neo4j.kernel.impl.api.TransactionRepresentationCommitProcess; +import org.neo4j.kernel.impl.api.index.IndexUpdatesValidator; +import org.neo4j.kernel.impl.api.index.IndexingService; +import org.neo4j.kernel.impl.core.CacheAccessBackDoor; +import org.neo4j.kernel.impl.index.IndexConfigStore; +import org.neo4j.kernel.impl.locking.LockGroup; +import org.neo4j.kernel.impl.locking.LockService; +import org.neo4j.kernel.impl.pagecache.StandalonePageCacheFactory; +import org.neo4j.kernel.impl.transaction.CommittedTransactionRepresentation; +import org.neo4j.kernel.impl.transaction.log.IOCursor; +import org.neo4j.kernel.impl.transaction.log.LogicalTransactionStore; +import org.neo4j.kernel.impl.transaction.log.ReadOnlyTransactionStore; +import org.neo4j.kernel.impl.transaction.log.TransactionIdStore; +import org.neo4j.kernel.impl.transaction.state.NeoStoreProvider; +import org.neo4j.kernel.impl.transaction.tracing.CommitEvent; +import org.neo4j.kernel.impl.util.IdOrderingQueue; +import org.neo4j.kernel.lifecycle.LifeSupport; +import org.neo4j.kernel.monitoring.Monitors; +import org.neo4j.tools.console.input.ArgsCommand; + +import static java.lang.String.format; + +import static org.neo4j.helpers.progress.ProgressMonitorFactory.textual; +import static org.neo4j.kernel.impl.api.TransactionApplicationMode.RECOVERY; + +public class ApplyTransactionsCommand extends ArgsCommand +{ + private final File from; + private final Provider to; + + public ApplyTransactionsCommand( File from, Provider to ) + { + this.from = from; + this.to = to; + } + + @Override + protected void run( Args args, PrintStream out ) throws Exception + { + TransactionIdStore txIdStore = to.instance().getDependencyResolver().resolveDependency( + TransactionIdStore.class ); + long fromTx = txIdStore.getLastCommittedTransaction().transactionId(); + long toTx; + if ( args.orphans().isEmpty() ) + { + throw new IllegalArgumentException( "No tx specified" ); + } + + String whereTo = args.orphans().get( 0 ); + if ( whereTo.equals( "next" ) ) + { + toTx = fromTx + 1; + } + else if ( whereTo.equals( "last" ) ) + { + toTx = Long.MAX_VALUE; + } + else + { + toTx = Long.parseLong( whereTo ); + } + + long lastApplied = applyTransactions( from, to.instance(), fromTx, toTx, out ); + out.println( "Applied transactions up to and including " + lastApplied ); + } + + private long applyTransactions( File fromPath, GraphDatabaseAPI toDb, long fromTxExclusive, long toTxInclusive, + PrintStream out ) + throws IOException, TransactionFailureException + { + DependencyResolver resolver = toDb.getDependencyResolver(); + BatchingTransactionRepresentationStoreApplier applier = new BatchingTransactionRepresentationStoreApplier( + resolver.resolveDependency( IndexingService.class ), + resolver.resolveDependency( LabelScanStore.class ), + resolver.resolveDependency( NeoStoreProvider.class ).evaluate(), + resolver.resolveDependency( CacheAccessBackDoor.class ), + resolver.resolveDependency( LockService.class ), + resolver.resolveDependency( LegacyIndexApplierLookup.class ), + resolver.resolveDependency( IndexConfigStore.class ), + resolver.resolveDependency( KernelHealth.class ), + resolver.resolveDependency( IdOrderingQueue.class ) ); + TransactionRepresentationCommitProcess commitProcess = + new TransactionRepresentationCommitProcess( + resolver.resolveDependency( LogicalTransactionStore.class ), + resolver.resolveDependency( NeoStoreProvider.class ).evaluate(), + applier, + resolver.resolveDependency( IndexUpdatesValidator.class ) ); + LifeSupport life = new LifeSupport(); + DefaultFileSystemAbstraction fileSystem = new DefaultFileSystemAbstraction(); + try ( PageCache pageCache = StandalonePageCacheFactory.createPageCache( fileSystem ) ) + { + LogicalTransactionStore source = life.add( new ReadOnlyTransactionStore( fileSystem, fromPath, + new Monitors(), resolver.resolveDependency( KernelHealth.class ) ) ); + life.start(); + long lastAppliedTx = fromTxExclusive; + // Some progress if there are more than a couple of transactions to apply + ProgressListener progress = toTxInclusive - fromTxExclusive >= 100 ? + textual( out ).singlePart( "Application progress", + toTxInclusive - fromTxExclusive ) : + ProgressListener.NONE; + try ( IOCursor cursor = source.getTransactions( fromTxExclusive + 1 ) ) + { + while ( cursor.next() ) + { + CommittedTransactionRepresentation transaction = cursor.get(); + try ( LockGroup locks = new LockGroup() ) + { + commitProcess.commit( transaction.getTransactionRepresentation(), locks, + CommitEvent.NULL, RECOVERY ); + progress.add( 1 ); + } + catch ( final Throwable e ) + { + System.err.println( "ERROR applying transaction " + transaction.getCommitEntry().getTxId() ); + throw e; + } + lastAppliedTx = transaction.getCommitEntry().getTxId(); + if ( lastAppliedTx == toTxInclusive ) + { + break; + } + } + } + applier.closeBatch(); + return lastAppliedTx; + } + finally + { + life.shutdown(); + } + } + + @Override + public String toString() + { + return ArrayUtil.join( new String[] { + "Applies transaction from the source onto the new db. Example:", + " apply last : applies transactions from the currently last applied and up to the last", + " transaction of source db", + " apply next : applies the next transaction onto the new db", + " apply 234 : applies up to and including tx 234 from the source db onto the new db" }, + format( "%n" ) ); + } +} diff --git a/tools/src/main/java/org/neo4j/tools/applytx/DatabaseRebuildTool.java b/tools/src/main/java/org/neo4j/tools/applytx/DatabaseRebuildTool.java new file mode 100644 index 0000000000000..518d8bb7fb0da --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/applytx/DatabaseRebuildTool.java @@ -0,0 +1,247 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.applytx; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.PrintStream; +import java.util.Map; +import java.util.concurrent.atomic.AtomicReference; + +import org.neo4j.consistency.ConsistencyCheckService; +import org.neo4j.consistency.ConsistencyCheckService.Result; +import org.neo4j.graphdb.factory.GraphDatabaseBuilder; +import org.neo4j.graphdb.factory.GraphDatabaseFactory; +import org.neo4j.helpers.Args; +import org.neo4j.helpers.Provider; +import org.neo4j.helpers.progress.ProgressMonitorFactory; +import org.neo4j.io.fs.FileUtils; +import org.neo4j.kernel.GraphDatabaseAPI; +import org.neo4j.kernel.configuration.Config; +import org.neo4j.kernel.impl.store.StoreAccess; +import org.neo4j.kernel.impl.util.Listener; +import org.neo4j.kernel.impl.util.StringLogger; +import org.neo4j.kernel.lifecycle.LifeSupport; +import org.neo4j.kernel.lifecycle.LifecycleAdapter; +import org.neo4j.tools.console.input.ArgsCommand; +import org.neo4j.tools.console.input.ConsoleInput; + +import static org.neo4j.tools.console.input.ConsoleUtil.NO_PROMPT; +import static org.neo4j.tools.console.input.ConsoleUtil.oneCommand; +import static org.neo4j.tools.console.input.ConsoleUtil.staticPrompt; + +/** + * Tool for rebuilding database from transaction logs onto a new store. Transaction can be applied interactively, + * i.e. applied up to any transaction id and consistency checked at any point. Also there are other utilities, + * such as printing record structure at any point as well. + * + * Running this tool will eventually go into a mode where it's awaiting user input, so typed commands + * will control what happens. Type help to get more information. + */ +public class DatabaseRebuildTool +{ + private final InputStream in; + private final PrintStream out; + private final PrintStream err; + + public DatabaseRebuildTool() + { + this( System.in, System.out, System.err ); + } + + public DatabaseRebuildTool( InputStream in, PrintStream out, PrintStream err ) + { + this.in = in; + this.out = out; + this.err = err; + } + + public static void main( String[] arguments ) throws Exception + { + new DatabaseRebuildTool().run( arguments ); + } + + public void run( String... arguments ) throws Exception + { + if ( arguments.length == 0 ) + { + System.err.println( "Tool for rebuilding database from transaction logs onto a new store" ); + System.err.println( "Example: dbrebuild --from path/to/some.db --to path/to/new.db apply next" ); + System.err.println( " dbrebuild --from path/to/some.db --to path/to/new.db -i" ); + System.err.println( " --from : which db to use as source for reading transactions" ); + System.err.println( " --to : where to build the new db" ); + System.err.println( " --overwrite-to : always starts from empty 'to' db" ); + System.err.println( " -i : interactive mode (enter a shell)" ); + return; + } + + Args args = Args.withFlags( "i", "overwrite-to" ).parse( arguments ); + File fromPath = getFrom( args ); + File toPath = getTo( args ); + GraphDatabaseBuilder dbBuilder = newDbBuilder( toPath, args ); + boolean interactive = args.getBoolean( "i" ); + if ( interactive && !args.orphans().isEmpty() ) + { + throw new IllegalArgumentException( "No additional commands allowed in interactive mode" ); + } + + @SuppressWarnings( "resource" ) + InputStream input = interactive ? in : oneCommand( args.orphansAsArray() ); + LifeSupport life = new LifeSupport(); + ConsoleInput consoleInput = console( fromPath, dbBuilder, input, + interactive ? staticPrompt( "# " ) : NO_PROMPT, life ); + life.start(); + try + { + consoleInput.waitFor(); + } + finally + { + life.shutdown(); + } + } + + private File getTo( Args args ) throws IOException + { + String to = args.get( "to" ); + if ( to == null ) + { + to = "target/db-from-apply-txs"; + err.println( "Defaulting --to to " + to ); + } + File toPath = new File( to ); + if ( args.getBoolean( "overwrite-to" ) ) + { + FileUtils.deleteRecursively( toPath ); + } + return toPath; + } + + private File getFrom( Args args ) + { + String from = args.get( "from" ); + if ( from == null ) + { + throw new IllegalArgumentException( "Missing --from i.e. from where to read transaction logs" ); + } + return new File( from ); + } + + private static GraphDatabaseBuilder newDbBuilder( File path, Args args ) + { + GraphDatabaseBuilder builder = new GraphDatabaseFactory().newEmbeddedDatabaseBuilder( path.getAbsolutePath() ); + for ( Map.Entry entry : args.asMap().entrySet() ) + { + if ( entry.getKey().startsWith( "D" ) ) + { + String key = entry.getKey().substring( 1 ); + String value = entry.getValue(); + builder = builder.setConfig( key, value ); + } + } + return builder; + } + + private static class Store + { + private final GraphDatabaseAPI db; + private final StoreAccess access; + private final File storeDir; + + public Store( GraphDatabaseBuilder dbBuilder ) + { + this.db = (GraphDatabaseAPI) dbBuilder.newGraphDatabase(); + this.access = new StoreAccess( db ); + this.storeDir = new File( db.getStoreDir() ); + } + + public void shutdown() + { + db.shutdown(); + } + } + + private ConsoleInput console( final File fromPath, final GraphDatabaseBuilder dbBuilder, + InputStream in, Listener prompt, LifeSupport life ) + throws Exception + { + // We must have this indirection here since in order to perform CC (one of the commands) we must shut down + // the database and let CC instantiate its own to run on. After that completes the db + // should be restored. The commands has references to providers of things to accommodate for this. + final AtomicReference store = + new AtomicReference<>( new Store( dbBuilder ) ); + final Provider storeAccess = new Provider() + { + @Override + public StoreAccess instance() + { + return store.get().access; + } + }; + final Provider dbAccess = new Provider() + { + @Override + public GraphDatabaseAPI instance() + { + return store.get().db; + } + }; + + ConsoleInput consoleInput = life.add( new ConsoleInput( in, out, prompt ) ); + consoleInput.add( "apply", new ApplyTransactionsCommand( fromPath, dbAccess ) ); + consoleInput.add( DumpRecordsCommand.NAME, new DumpRecordsCommand( storeAccess ) ); + consoleInput.add( "cc", new ArgsCommand() + { + @Override + public void run( Args action, PrintStream out ) throws Exception + { + File storeDir = store.get().storeDir; + store.get().shutdown(); + try + { + Result result = new ConsistencyCheckService().runFullConsistencyCheck( storeDir.getAbsolutePath(), + new Config(), ProgressMonitorFactory.textual( out ), + StringLogger.SYSTEM ); + out.println( (result.isSuccessful() ? "consistent" : "INCONSISTENT") ); + } + finally + { + store.set( new Store( dbBuilder ) ); + } + } + + @Override + public String toString() + { + return "Runs consistency check on the database for data that has been applied up to this point"; + } + } ); + life.add( new LifecycleAdapter() + { + @Override + public void shutdown() + { + store.get().shutdown(); + } + } ); + return consoleInput; + } +} diff --git a/tools/src/main/java/org/neo4j/tools/applytx/DumpRecordsCommand.java b/tools/src/main/java/org/neo4j/tools/applytx/DumpRecordsCommand.java new file mode 100644 index 0000000000000..c75891226d765 --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/applytx/DumpRecordsCommand.java @@ -0,0 +1,231 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.applytx; + +import io.airlift.airline.Arguments; +import io.airlift.airline.Cli; +import io.airlift.airline.Cli.CliBuilder; + +import java.io.PrintStream; + +import org.neo4j.helpers.Provider; +import org.neo4j.kernel.impl.core.Token; +import org.neo4j.kernel.impl.store.LabelTokenStore; +import org.neo4j.kernel.impl.store.PropertyKeyTokenStore; +import org.neo4j.kernel.impl.store.RelationshipTypeTokenStore; +import org.neo4j.kernel.impl.store.StoreAccess; +import org.neo4j.kernel.impl.store.record.NodeRecord; +import org.neo4j.kernel.impl.store.record.PropertyRecord; +import org.neo4j.kernel.impl.store.record.Record; +import org.neo4j.kernel.impl.store.record.RelationshipGroupRecord; +import org.neo4j.kernel.impl.store.record.RelationshipRecord; +import org.neo4j.tools.console.input.Command; +import org.neo4j.tools.console.input.ConsoleInput; + +import static org.neo4j.tools.console.input.ConsoleUtil.airlineHelp; + +/** + * Able to dump records and record chains. Works as a {@link ConsoleInput} {@link Command}. + */ +public class DumpRecordsCommand implements Command +{ + public static final String NAME = "dump"; + + private interface Action + { + void run( StoreAccess store, PrintStream out ); + } + + private final Cli cli; + private final Provider store; + + @SuppressWarnings( "unchecked" ) + public DumpRecordsCommand( Provider store ) + { + this.store = store; + CliBuilder builder = Cli.builder( NAME ) + .withDescription( "Dump record contents" ) + .withCommands( DumpRelationshipTypes.class, Help.class ) + .withDefaultCommand( Help.class ); + builder.withGroup( "node" ) + .withCommands( DumpNodePropertyChain.class, DumpNodeRelationshipChain.class, Help.class ) + .withDefaultCommand( Help.class ); + builder.withGroup( "relationship" ) + .withCommands( DumpRelationshipPropertyChain.class, Help.class ) + .withDefaultCommand( Help.class ); + builder.withGroup( "tokens" ) + .withCommands( DumpRelationshipTypes.class, DumpLabels.class, DumpPropertyKeys.class, Help.class ) + .withDefaultCommand( Help.class ); + this.cli = builder.build(); + } + + @Override + public void run( String[] args, PrintStream out ) throws Exception + { + cli.parse( args ).run( store.instance(), out ); + } + + @Override + public String toString() + { + return airlineHelp( cli ); + } + + static abstract class DumpPropertyChain implements Action + { + @Arguments( title = "id", description = "Entity id", required = true ) + public long id; + + protected abstract long firstPropId( StoreAccess access ); + + @Override + public void run( StoreAccess store, PrintStream out ) + { + long propId = firstPropId( store ); + while ( propId != Record.NO_NEXT_PROPERTY.intValue() ) + { + PropertyRecord record = store.getPropertyStore().getRecord( propId ); + out.println( record ); + propId = record.getNextProp(); + } + } + } + + @io.airlift.airline.Command( name = "properties", description = "Dump property chain for a node" ) + public static class DumpNodePropertyChain extends DumpPropertyChain + { + @Override + protected long firstPropId( StoreAccess access ) + { + return access.getNodeStore().getRecord( id ).getNextProp(); + } + } + + @io.airlift.airline.Command( name = "properties", description = "Dump property chain for a relationship" ) + public static class DumpRelationshipPropertyChain extends DumpPropertyChain + { + @Override + protected long firstPropId( StoreAccess access ) + { + return access.getRelationshipStore().getRecord( id ).getNextProp(); + } + } + + @io.airlift.airline.Command( name = "relationships", description = "Dump relationship chain for a node" ) + public static class DumpNodeRelationshipChain implements Action + { + @Arguments( description = "Node id", required = true ) + public long id; + + @Override + public void run( StoreAccess store, PrintStream out ) + { + NodeRecord node = store.getNodeStore().getRecord( id ); + if ( node.isDense() ) + { + RelationshipGroupRecord group = store.getRelationshipGroupStore().getRecord( node.getNextRel() ); + do + { + out.println( "group " + group ); + out.println( "out:" ); + printRelChain( store, out, group.getFirstOut() ); + out.println( "in:" ); + printRelChain( store, out, group.getFirstIn() ); + out.println( "loop:" ); + printRelChain( store, out, group.getFirstLoop() ); + group = group.getNext() != -1 ? + store.getRelationshipGroupStore().getRecord( group.getNext() ) : null; + } while ( group != null ); + } + else + { + printRelChain( store, out, node.getNextRel() ); + } + } + + private void printRelChain( StoreAccess access, PrintStream out, long firstRelId ) + { + for ( long rel = firstRelId; rel != Record.NO_NEXT_RELATIONSHIP.intValue(); ) + { + RelationshipRecord record = access.getRelationshipStore().getRecord( rel ); + out.println( rel + "\t" + record ); + if ( record.getFirstNode() == id ) + { + rel = record.getFirstNextRel(); + } + else + { + rel = record.getSecondNextRel(); + } + } + } + } + + @io.airlift.airline.Command( name = "relationship-type", description = "Dump relationship type tokens" ) + public static class DumpRelationshipTypes implements Action + { + @Override + public void run( StoreAccess store, PrintStream out ) + { + for ( Token token : ((RelationshipTypeTokenStore) + store.getRelationshipTypeTokenStore()).getTokens( Integer.MAX_VALUE ) ) + { + out.println( token ); + } + } + } + + @io.airlift.airline.Command( name = "label", description = "Dump label tokens" ) + public static class DumpLabels implements Action + { + @Override + public void run( StoreAccess store, PrintStream out ) + { + for ( Token token : ((LabelTokenStore) + store.getLabelTokenStore()).getTokens( Integer.MAX_VALUE ) ) + { + out.println( token ); + } + } + } + + @io.airlift.airline.Command( name = "property-key", description = "Dump property key tokens" ) + public static class DumpPropertyKeys implements Action + { + @Override + public void run( StoreAccess store, PrintStream out ) + { + for ( Token token : ((PropertyKeyTokenStore) + store.getPropertyKeyTokenStore()).getTokens( Integer.MAX_VALUE ) ) + { + out.println( token ); + } + } + } + + public static class Help extends io.airlift.airline.Help implements Action + { + @Override + public void run( StoreAccess store, PrintStream out ) + { + run(); + } + } +} diff --git a/tools/src/main/java/org/neo4j/tools/console/input/ArgsCommand.java b/tools/src/main/java/org/neo4j/tools/console/input/ArgsCommand.java new file mode 100644 index 0000000000000..d1447f3bcf8c2 --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/console/input/ArgsCommand.java @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.console.input; + +import java.io.PrintStream; + +import org.neo4j.helpers.Args; + +public abstract class ArgsCommand implements Command +{ + @Override + public final void run( String[] args, PrintStream out ) throws Exception + { + run( Args.parse( args ), out ); + } + + protected abstract void run( Args args, PrintStream out ) throws Exception; +} diff --git a/tools/src/main/java/org/neo4j/tools/console/input/Command.java b/tools/src/main/java/org/neo4j/tools/console/input/Command.java new file mode 100644 index 0000000000000..8c8e5ecfc40d1 --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/console/input/Command.java @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.console.input; + +import java.io.PrintStream; + +/** + * Action to be run for a specific command, read from {@link ConsoleInput}. + */ +public interface Command +{ + void run( String[] args, PrintStream out ) throws Exception; +} diff --git a/tools/src/main/java/org/neo4j/tools/console/input/ConsoleInput.java b/tools/src/main/java/org/neo4j/tools/console/input/ConsoleInput.java new file mode 100644 index 0000000000000..7785e7b584d3f --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/console/input/ConsoleInput.java @@ -0,0 +1,186 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.console.input; + +import java.io.BufferedReader; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.PrintStream; +import java.util.HashMap; +import java.util.Map; + +import org.neo4j.kernel.impl.util.Listener; +import org.neo4j.kernel.lifecycle.LifecycleAdapter; + +import static java.util.Arrays.copyOfRange; + +import static org.neo4j.tools.console.input.ConsoleUtil.tokenizeStringWithQuotes; + +/** + * Useful utility which listens to input from console and reacts to each line, i.e. after each ENTER. + * {@link Command} are added with {@link #add(String, Command)} and are then reacted to in a separate thread, + * which continuously sits and listens to console input. + * + * Use of this class can be a shell-like tool which boots up, instantiates a {@link ConsoleInput}, + * {@link #start() starts it} followed by {@link #waitFor()} which will block until the input stream ends + * or an exit command is issued. + * + * Another use is to instantiate {@link ConsoleInput}, {@link #start() start it} and then move on to do + * something else entirely. That way the commands added here will be available user input something in + * the console while all other things are happening. In this case {@link #shutdown()} should be called + * when the application otherwise shuts down. + */ +public class ConsoleInput extends LifecycleAdapter +{ + private final Map commands = new HashMap<>(); + private Reactor reactor; + private final BufferedReader inputReader; + private final Listener prompt; + private final PrintStream out; + + public ConsoleInput( InputStream input, PrintStream out, Listener prompt ) + { + this.out = out; + this.prompt = prompt; + this.inputReader = new BufferedReader( new InputStreamReader( input ) ); + } + + /** + * Add {@link Command} to be available and executed when input uses it. + * + * @param name command name, i.e the first word of the whole command line to listen for. + * @param command {@link Command} to {@link Command#run(String[]) run} as part of command line + * starting with {@code name}- + */ + public void add( String name, Command command ) + { + commands.put( name, command ); + } + + /** + * Starts to listen on the input supplied in constructor. + */ + @Override + public void start() + { + reactor = new Reactor(); + reactor.start(); + } + + /** + * Waits till input stream ends or exit command is given. + */ + public void waitFor() throws InterruptedException + { + reactor.join(); + } + + /** + * Shuts down and stops listen on the input. + */ + @Override + public void stop() throws InterruptedException + { + reactor.halt(); + waitFor(); + } + + /** + * Prints usage and help for all available commands. + */ + public void printUsage() + { + out.println( "Available commands:" ); + for ( Map.Entry entry : commands.entrySet() ) + { + out.println( entry.getKey() + ": " + entry.getValue() ); + } + } + + private class Reactor extends Thread + { + private volatile boolean halted; + + public Reactor() + { + super( ConsoleInput.class.getSimpleName() + " reactor" ); + } + + void halt() + { + halted = true; + + // Interrupt this thread since it's probably sitting listening to input. + interrupt(); + } + + @Override + public void run() + { + while ( !halted ) + { + try + { + prompt.receive( out ); + String commandLine = inputReader.readLine(); // Blocking call + if ( commandLine == null ) + { + halted = true; + break; + } + + String[] args = tokenizeStringWithQuotes( commandLine ); + if ( args.length == 0 ) + { + continue; + } + String commandName = args[0]; + Command action = commands.get( commandName ); + if ( action != null ) + { + action.run( copyOfRange( args, 1, args.length ), out ); + } + else + { + switch ( commandName ) + { + case "help": + case "?": + case "man": + printUsage(); + break; + case "exit": + halt(); + break; + default: + System.err.println( "Unrecognized command '" + commandName + "'" ); + break; + } + } + } + catch ( Exception e ) + { + e.printStackTrace(); + // The show must go on + } + } + } + } +} diff --git a/tools/src/main/java/org/neo4j/tools/console/input/ConsoleUtil.java b/tools/src/main/java/org/neo4j/tools/console/input/ConsoleUtil.java new file mode 100644 index 0000000000000..4e45c78b8ddae --- /dev/null +++ b/tools/src/main/java/org/neo4j/tools/console/input/ConsoleUtil.java @@ -0,0 +1,148 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.console.input; + +import io.airlift.airline.Cli; +import io.airlift.airline.Help; + +import java.io.ByteArrayInputStream; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.PrintStream; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.StringTokenizer; + +import org.neo4j.kernel.impl.util.Listener; + +import static org.neo4j.helpers.ArrayUtil.join; + +public class ConsoleUtil +{ + public static final Listener NO_PROMPT = new Listener() + { + @Override + public void receive( PrintStream out ) + { // Do nothing + } + }; + + public static final Listener staticPrompt( final String prompt ) + { + return new Listener() + { + @Override + public void receive( PrintStream out ) + { + out.print( prompt ); + } + }; + } + + public static final OutputStream NULL_OUTPUT_STREAM = new OutputStream() + { + @Override + public void close(){} + @Override + public void flush(){} + @Override + public void write(byte[]b){} + @Override + public void write(byte[]b,int i,int l){} + @Override + public void write(int b){} + }; + + public static final PrintStream NULL_PRINT_STREAM = new PrintStream( NULL_OUTPUT_STREAM ); + + public static String[] tokenizeStringWithQuotes( String string ) + { + ArrayList result = new ArrayList<>(); + string = string.trim(); + boolean inside = string.startsWith( "\"" ); + StringTokenizer quoteTokenizer = new StringTokenizer( string, "\"" ); + while ( quoteTokenizer.hasMoreTokens() ) + { + String token = quoteTokenizer.nextToken(); + token = token.trim(); + if ( token.length() == 0 ) + { + // Skip it + } + else if ( inside ) + { + // Don't split + result.add( token ); + } + else + { + splitAndKeepEscapedSpaces( token, false, result ); + } + inside = !inside; + } + return result.toArray( new String[result.size()] ); + } + + private static void splitAndKeepEscapedSpaces( String string, boolean preserveEscapes, Collection into ) + { + StringBuilder current = new StringBuilder(); + for ( int i = 0; i < string.length(); i++ ) + { + char ch = string.charAt( i ); + if ( ch == ' ' ) + { + boolean isGluedSpace = i > 0 && string.charAt( i-1 ) == '\\'; + if ( !isGluedSpace ) + { + into.add( current.toString() ); + current = new StringBuilder(); + continue; + } + } + + if ( preserveEscapes || ch != '\\' ) + { + current.append( ch ); + } + } + if ( current.length() > 0 ) + { + into.add( current.toString() ); + } + } + + public static InputStream oneCommand( String... args ) + { + String string = join( args, " " ); + return new ByteArrayInputStream( string.getBytes() ); + } + + public static String airlineHelp( Cli cli ) + { + StringBuilder builder = new StringBuilder(); + Help.help( cli.getMetadata(), Collections.emptyList(), builder ); + return builder.toString(); + } + + private ConsoleUtil() + { + } +} diff --git a/tools/src/main/java/org/neo4j/tools/txlog/CheckTxLogs.java b/tools/src/main/java/org/neo4j/tools/txlog/CheckTxLogs.java index 44db3a94bbc20..4d4f106a137d8 100644 --- a/tools/src/main/java/org/neo4j/tools/txlog/CheckTxLogs.java +++ b/tools/src/main/java/org/neo4j/tools/txlog/CheckTxLogs.java @@ -60,7 +60,7 @@ public CheckTxLogs( FileSystemAbstraction fs ) public static void main( String[] args ) throws Exception { Args arguments = Args.withFlags( HELP_FLAG ).parse( args ); - if ( arguments.getBoolean( HELP_FLAG, false ) ) + if ( arguments.getBoolean( HELP_FLAG ) ) { printUsageAndExit(); } diff --git a/tools/src/test/java/org/neo4j/tools/applytx/DatabaseRebuildToolTest.java b/tools/src/test/java/org/neo4j/tools/applytx/DatabaseRebuildToolTest.java new file mode 100644 index 0000000000000..d3c55eee34cc5 --- /dev/null +++ b/tools/src/test/java/org/neo4j/tools/applytx/DatabaseRebuildToolTest.java @@ -0,0 +1,225 @@ +/* + * Copyright (c) 2002-2015 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package org.neo4j.tools.applytx; + +import org.junit.Rule; +import org.junit.Test; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.InputStream; +import java.io.PrintStream; + +import org.neo4j.graphdb.GraphDatabaseService; +import org.neo4j.graphdb.Node; +import org.neo4j.graphdb.PropertyContainer; +import org.neo4j.graphdb.Relationship; +import org.neo4j.graphdb.Transaction; +import org.neo4j.graphdb.factory.GraphDatabaseFactory; +import org.neo4j.io.fs.DefaultFileSystemAbstraction; +import org.neo4j.kernel.impl.store.NeoStore; +import org.neo4j.kernel.impl.store.NeoStore.Position; +import org.neo4j.kernel.impl.transaction.log.TransactionIdStore; +import org.neo4j.test.DbRepresentation; +import org.neo4j.test.TargetDirectory; + +import static org.hamcrest.Matchers.containsString; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertThat; + +import static java.lang.String.format; + +import static org.neo4j.graphdb.DynamicLabel.label; +import static org.neo4j.graphdb.DynamicRelationshipType.withName; +import static org.neo4j.tools.console.input.ConsoleUtil.NULL_PRINT_STREAM; + +public class DatabaseRebuildToolTest +{ + @Rule + public final TargetDirectory.TestDirectory directory = TargetDirectory.testDirForTest( getClass() ); + + @Test + public void shouldRebuildDbFromTransactions() throws Exception + { + // This tests the basic functionality of this tool, there are more things, but it's not as important + // to test as the functionality of applying transactions. + + // GIVEN + File from = directory.directory( "from" ); + File to = directory.directory( "to" ); + databaseWithSomeTransactions( from ); + DatabaseRebuildTool tool = new DatabaseRebuildTool( System.in, NULL_PRINT_STREAM, NULL_PRINT_STREAM ); + + // WHEN + tool.run( "--from", from.getAbsolutePath(), "--to", to.getAbsolutePath(), "apply last" ); + + // THEN + assertEquals( DbRepresentation.of( from ), DbRepresentation.of( to ) ); + } + + @Test + public void shouldApplySomeTransactions() throws Exception + { + // This tests the basic functionality of this tool, there are more things, but it's not as important + // to test as the functionality of applying transactions. + + // GIVEN + File from = directory.directory( "from" ); + File to = directory.directory( "to" ); + databaseWithSomeTransactions( from ); + DatabaseRebuildTool tool = new DatabaseRebuildTool( input( "apply next", "apply next", "cc", "exit" ), + NULL_PRINT_STREAM, NULL_PRINT_STREAM ); + + // WHEN + tool.run( "--from", from.getAbsolutePath(), "--to", to.getAbsolutePath(), "-i" ); + + // THEN + assertEquals( TransactionIdStore.BASE_TX_ID + 2, lastAppliedTx( to ) ); + } + + @Test + public void shouldDumpNodePropertyChain() throws Exception + { + shouldPrint( "dump node properties 0", + "Property", + "name0" ); + } + + @Test + public void shouldDumpRelationshipPropertyChain() throws Exception + { + shouldPrint( "dump relationship properties 0", + "Property", + "name0" ); + } + + @Test + public void shouldDumpRelationships() throws Exception + { + shouldPrint( "dump node relationships 0", + "Relationship[0,", + "Relationship[10," ); + } + + @Test + public void shouldDumpRelationshipTypeTokens() throws Exception + { + shouldPrint( "dump tokens relationship-type", + "TYPE_0", + "TYPE_1" ); + } + + @Test + public void shouldDumpLabelTokens() throws Exception + { + shouldPrint( "dump tokens label", + "Label_0", + "Label_1" ); + } + + @Test + public void shouldDumpPropertyKeyTokens() throws Exception + { + shouldPrint( "dump tokens property-key", + "name" ); + } + + private void shouldPrint( String command, String... expectedResultContaining ) throws Exception + { + // GIVEN + File from = directory.directory( "from" ); + File to = directory.directory( "to" ); + databaseWithSomeTransactions( to ); + ByteArrayOutputStream byteArrayOut = new ByteArrayOutputStream(); + PrintStream out = new PrintStream( byteArrayOut ); + DatabaseRebuildTool tool = new DatabaseRebuildTool( input( command, "exit" ), + out, NULL_PRINT_STREAM ); + + // WHEN + tool.run( "--from", from.getAbsolutePath(), "--to", to.getAbsolutePath(), "-i" ); + + // THEN + out.flush(); + String dump = new String( byteArrayOut.toByteArray() ); + for ( String string : expectedResultContaining ) + { + assertThat( dump, containsString( string ) ); + } + } + + private long lastAppliedTx( File storeDir ) + { + return NeoStore.getRecord( new DefaultFileSystemAbstraction(), new File( storeDir, NeoStore.DEFAULT_NAME ), + Position.LAST_TRANSACTION_ID ); + } + + private InputStream input( String... strings ) + { + StringBuilder all = new StringBuilder(); + for ( String string : strings ) + { + all.append( string ).append( format( "%n" ) ); + } + return new ByteArrayInputStream( all.toString().getBytes() ); + } + + private void databaseWithSomeTransactions( File dir ) + { + GraphDatabaseService db = new GraphDatabaseFactory().newEmbeddedDatabase( dir.getAbsolutePath() ); + Node[] nodes = new Node[10]; + for ( int i = 0; i < nodes.length; i++ ) + { + try ( Transaction tx = db.beginTx() ) + { + Node node = db.createNode( label( "Label_" + (i%2) ) ); + setProperties( node, i ); + nodes[i] = node; + tx.success(); + } + } + for ( int i = 0; i < 40; i++ ) + { + try ( Transaction tx = db.beginTx() ) + { + Relationship relationship = + nodes[i%nodes.length].createRelationshipTo( nodes[(i+1)%nodes.length], withName( "TYPE_" + (i%3) ) ); + setProperties( relationship, i ); + tx.success(); + } + } + try ( Transaction tx = db.beginTx() ) + { + Node node = nodes[nodes.length-1]; + for ( Relationship relationship : node.getRelationships() ) + { + relationship.delete(); + } + node.delete(); + tx.success(); + } + db.shutdown(); + } + + private void setProperties( PropertyContainer entity, int i ) + { + entity.setProperty( "key", "name" + i ); + } +}