diff --git a/.gitignore b/.gitignore index 22dddac5b21..6b354dc9f9c 100644 --- a/.gitignore +++ b/.gitignore @@ -82,3 +82,4 @@ chromedriver node_modules package-lock.json .project +.DS_Store diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a861c3649f..bb9a5f2950a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,34 @@ +# Contributing -Please have a look at our contributing guidelines at https://github.com/geonetwork/core-geonetwork/wiki/How-to-contribute +Thank you for contributing to GeoNetwork: + +* Free-software: GeoNetwork is free-software, using the [GNU GENERAL PUBLIC LICENSE](LICENSE.md). Contributions provided by you, or your employer, are required to be compatible with this free-software license. +* Pull-request: GeoNetwork uses a pull-request workflow to review and accept changes. Pull-requests must be submitted against the *master* branch first, and may be back ported as required. + +# Pull requests + +* Pull request is required, even if you have commit access, so the tests are run and other developer can check your code. + +* Pull requests must be applied to `master`, before being backported. + +* Good housekeeping: Anytime you commit, try and clean the code around it to latest style guide. If you improve a function without comments: add comments. If you modify functionality that does not have tests: write a test. If you fix functionality without documentation: add documentation. + +* History: Clean commit messages and history: avoid big commits with hundreds of files, break commits commits up into understandable chunks, longer verbose commit messages are encouraged. Beware of reformatting and needless whitespace changes. + +* Draft: Use pull request *Draft** (or even the text "WIP") to identify work in progress. + +* Rebase: No merge commits with current branch: use rebase! + +* API Change: Please identify any API change or behavior changes in commit messages. + +* Review: Review is required by another person, or more than one! Don't be shy asking for help or reviewing. + +* Testing: All new features or enhancements require automatic tests (see [testing](software_development/TESTING.md)) + +* User documentation: All new features or enhancements require documentation (see [doc](https://github.com/geonetwork/doc)) + +* Build documentation: All build and development instructions managed in repository `README.md` files. + +* New libraries: Do not commit jars, use maven `pom.xml` to declare dependencies where needed, and `src/pom.xml` dependency management to manage version numbers. Document what the library does in GeoNetwork, how it interacts or extends GeoNetwork, with references to official library tutorials or documentation. + +For more information see [How to contribute](https://github.com/geonetwork/core-geonetwork/wiki/How-to-contribute) (wiki). diff --git a/LICENSE b/LICENSE deleted file mode 100644 index d159169d105..00000000000 --- a/LICENSE +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 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. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -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 Program or any portion -of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -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 Program, 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 Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) 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; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, 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 executable. However, as a -special exception, the source code 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. - -If distribution of executable or 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 counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program 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. - - 5. 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 Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program 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 to -this License. - - 7. 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 Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program 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 Program. - -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. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program 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. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 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 Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, 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 - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - - 12. 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 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. - - 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 -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 program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, 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. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000000..28fbecabf5c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,361 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 2, June 1991 + + Copyright (C) 1989, 1991 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. + +### Preamble + +The licenses for most software are designed to take away your freedom +to share and change it. By contrast, the GNU General Public License is +intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if +you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + +We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, +we want its recipients to know that what they have is not the +original, so that any problems introduced by others will not reflect +on the original authors' reputations. + +Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at +all. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +**0.** This License applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work +based on the Program" means either the Program or any derivative work +under copyright law: that is to say, a work containing the Program or +a portion of it, either verbatim or with modifications and/or +translated into another language. (Hereinafter, translation is +included without limitation in the term "modification".) Each licensee +is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the Program +(independent of having been made by running the Program). Whether that +is true depends on what the Program does. + +**1.** You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any +portion of it, thus forming a work based on the Program, 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)** You must cause the modified files to carry prominent notices +stating that you changed the files and the date of any change. + + +**b)** You must cause any work that you distribute or publish, that in +whole or in part contains or is derived from the Program or any part +thereof, to be licensed as a whole at no charge to all third parties +under the terms of this License. + + +**c)** If the modified program normally reads commands interactively +when run, you must cause it, when started running for such interactive +use in the most ordinary way, to print or display an announcement +including an appropriate copyright notice and a notice that there is +no warranty (or else, saying that you provide a warranty) and that +users may redistribute the program under these conditions, and telling +the user how to view a copy of this License. (Exception: if the +Program itself is interactive but does not normally print such an +announcement, your work based on the Program is not required to print +an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + +**3.** You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + +**a)** 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; or, + + +**b)** Accompany it with a written offer, valid for at least three +years, to give any third party, for a charge no more than your cost of +physically performing source distribution, a complete machine-readable +copy of the corresponding source code, to be distributed under the +terms of Sections 1 and 2 above on a medium customarily used for +software interchange; or, + + +**c)** Accompany it with the information you received as to the offer +to distribute corresponding source code. (This alternative is allowed +only for noncommercial distribution and only if you received the +program in object code or executable form with such an offer, in +accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + +**4.** You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt otherwise +to copy, modify, sublicense or distribute the Program 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. + +**5.** 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +**6.** Each time you redistribute the Program (or any work based on +the Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + +**7.** 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 Program at all. For +example, if a patent license would not permit royalty-free +redistribution of the Program 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 +Program. + +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. + +**8.** If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + +**9.** The Free Software Foundation may publish revised and/or new +versions of the 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 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 Program does not specify a +version number of this License, you may choose any version ever +published by the Free Software Foundation. + +**10.** If you wish to incorporate parts of the Program into other +free programs whose distribution conditions are different, 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** + +**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + +**12.** 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 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. + +### 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 +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. + + one line to give the program's name and an idea of what it does. + Copyright (C) yyyy name of author + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, 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. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details + type `show w'. This is free software, and you are welcome + to redistribute it under certain conditions; type `show c' + for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than \`show w' and +\`show c'; they could even be mouse-clicks or menu items--whatever +suits your program. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the program, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright + interest in the program `Gnomovision' + (which makes passes at compilers) written + by James Hacker. + + signature of Ty Coon, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, +you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +[GNU Lesser General Public +License](https://www.gnu.org/licenses/lgpl.html) instead of this +License. diff --git a/README.md b/README.md index 141f3b80527..488c8fabcb6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# GeoNetwork Open-soucce + # Build Health [![Build Status](https://travis-ci.org/geonetwork/core-geonetwork.svg?branch=master)](https://travis-ci.org/geonetwork/core-geonetwork) @@ -15,45 +17,13 @@ # Documentation -User documentation is in the docs submodule in the current repository and is compiled into html pages during a release for publishing on -a website. - -Developer documentation is also in the docs submodule but is being migrated out of that project into the Readme files in each module -in the project. General documentation for the project as a whole is in this Readme and module specific documentation can be found in -each module (assuming there is module specific documentation required). - -# Software Development - -Instructions for setting up a development environment/building Geonetwork/compiling user documentation/making a release see: -[Software Development Documentation](/software_development/) - -# Testing - -With regards to testing Geonetwork is a standard Java project and primarily depends on JUnit for testing. However there is a very important -issue to consider when writing JUnit tests in Geonetwork and that is the separation between unit tests and integration tests - -* *Unit Tests* - In Geonetwork unit tests should be very very quick to execute and not start up any subsystems of the application in order to keep - the execution time of the unit tests very short. Integration tests do not require super classes and any assistance methods can be static - imports, for example statically importing org.junit.Assert or org.junit.Assume or org.fao.geonet.Assert. -* *Integration Tests* - Integration Test typically start much or all of Geonetwork as part of the test and will take longer to run than - a unit test. However, even though the tests take longer they should still be implemented in such a way to be as efficient as possible. - Starting Geonetwork in a way that isolates each integration test from each other integration test is non-trivial. Because of this - there are `abstract` super classes to assist with this. Many modules have module specific Abstract classes. For example at the time - that this is being written `domain`, `core`, `harvesters` and `services` modules all have module specific super classes that need to - be used. (`harvesting` has 2 superclasses depending on what is to be tested.) - The easiest way to learn how to implement an integration test is to search for other integration tests in the same module as the class - you want to test. The following list provides a few tips: - * *IMPORTANT*: All Integrations tests *must* end in IntegrationTest. The build system assumes all tests ending in IntegrationTest is - an integration test and runs them in a build phase after unit tests. All other tests are assumed to be unit tests. - * Prefer unit tests over Integration Tests because they are faster. - * Search the current module for IntegrationTest to find tests to model your integration test against - * This you might want integration tests for are: - * Services: If the service already exists and you quick need to write a test to debug/fix its behaviour. - If you are writing a new service it is better to use Mockito to mock the dependencies of the service so the test is - a unit test. - * Harvesters - * A behaviour that crosses much of the full system - -*org.fao.geonet.utils.GeonetHttpRequestFactory*: When making Http requests you should use org.fao.geonet.utils.GeonetHttpRequestFactory instead - of directly using HttpClient. This is because there are mock instances of org.fao.geonet.utils.GeonetHttpRequestFactory that can - be used to mock responses when performing tests. +User documentation is managed in the [geonetwork/doc](https://github.com/geonetwork/doc) repository covering all releases of GeoNetwork. + +The `docs` folder includes [geonetwork/doc](https://github.com/geonetwork/doc) as a git submodule. This documentation is compiled into html pages during a release for publishing on the [geonetwork-opensource.org](http://geonetwork-opensource.org) website. + +Developer documentation located in README.md files in the code-base: + +* General documentation for the project as a whole is in this README.md +* [Software Development Documentation](/software_development/) provides instructions for setting up a development environment, building Geonetwork, compiling user documentation, and making a releases +* Module specific documentation can be found in each module (assuming there is module specific documentation required) + diff --git a/software_development/BUILDING.md b/software_development/BUILDING.md new file mode 100644 index 00000000000..41b7686548e --- /dev/null +++ b/software_development/BUILDING.md @@ -0,0 +1,99 @@ +# Building + +See [Installing from source code](https://geonetwork-opensource.org/manuals/trunk/en/maintainer-guide/installing/installing-from-source-code.html) (Maintainer Guide) + +Build GeoNetwork +---------------- + +Once you checked out the code from Github repository, go inside the GeoNetwork’s root folder and execute the maven build command: + +``` +mvn clean install +``` + +If the build is successful you'll get an output like: +``` +[INFO] +[INFO] ------------------------------------------------------------------------ +[INFO] Reactor Summary: +[INFO] ------------------------------------------------------------------------ +[INFO] GeoNetwork opensource ................................. SUCCESS [1.345s] +[INFO] Caching xslt module ................................... SUCCESS [1.126s] +[INFO] Jeeves modules ........................................ SUCCESS [3.970s] +[INFO] ArcSDE module (dummy-api) ............................. SUCCESS [0.566s] +[INFO] GeoNetwork web client module .......................... SUCCESS [23.084s] +[INFO] GeoNetwork user interface module ...................... SUCCESS [15.940s] +[INFO] Oaipmh modules ........................................ SUCCESS [1.029s] +[INFO] GeoNetwork domain ..................................... SUCCESS [0.808s] +[INFO] GeoNetwork core ....................................... SUCCESS [6.426s] +[INFO] GeoNetwork CSW server ................................. SUCCESS [2.050s] +[INFO] GeoNetwork health monitor ............................. SUCCESS [1.014s] +[INFO] GeoNetwork harvesters ................................. SUCCESS [2.583s] +[INFO] GeoNetwork services ................................... SUCCESS [3.178s] +[INFO] GeoNetwork Web module ................................. SUCCESS [2:31.387s] +[INFO] ------------------------------------------------------------------------ +[INFO] ------------------------------------------------------------------------ +[INFO] BUILD SUCCESSFUL +[INFO] ------------------------------------------------------------------------ +[INFO] Total time: 3 minutes 35 seconds +[INFO] Finished at: Sun Oct 27 16:21:46 CET 2013 +``` + +Your local maven repository now contain the GeoNetwork artifacts created (``$HOME/.m2/repository/org/geonetwork-opensource``). + +Compilation options +------------------- + +Many Maven build options are available, for instance, you might like to use following options : + +* To skip tests: + + ``` + mvn install -DskipTests + ``` + +* Offline use: + + ``` + mvn install -o + ``` + +* Build really fast with 2 threads per cpu core + + ``` + mvn install -o -DskipTests -T 2C + ``` + +Please refer to the maven documentation for additional options, [Maven: The Complete Reference](http://www.sonatype.com/books/mvnref-book/reference/public-book.html) + +Maven Profiles +-------------- + +Maven profiles are used to enable additional build configuration. + +Some components (eg. WFS feature indexing) of the application rely on an Elasticsearch instance. To enable those options, build the application with the ```es``` profile. + +``` +mvn clean install -Pes +``` + +Run embedded Jetty server +------------------------- + +Maven comes with built-in support for Jetty via a [plug-in](https://www.eclipse.org/jetty/documentation/current/jetty-maven-plugin.html) + +To run GeoNetwork with the embedded Jetty server you have to change directory to the root of the **web** module, +and then execute the following maven command: + +``` +cd web +mvn jetty:run -Penv-dev +``` + +After a moment, GeoNetwork should be accessible at: http://localhost:8080/geonetwork + +For changes related to the user interface in the `web-ui` module or the metadata schemas in the `schemas` module, can be deployed in jetty executing the following maven command in the **web** module: + +``` +mvn process-resources +``` diff --git a/software_development/ECLIPSE.md b/software_development/ECLIPSE.md new file mode 100644 index 00000000000..fa86694109e --- /dev/null +++ b/software_development/ECLIPSE.md @@ -0,0 +1,176 @@ +# Eclipse IDE + +The [Eclipse Foundation](https://www.eclipse.org/) produces several distributions of the Eclipse IDE. The "Eclipse IDE for Java Developers" and "Eclipse IDE for Enterprise Java Developers" can be used for GeoNetwork development. + +Eclipse provides maven integration using the built-in [M2Eclipse](http://eclipse.org/m2e/) plugin. + +The Eclipse IDE is recommended for excellent refactoring support. + +## Import source code + +In order to import the source code, follow instructions below: + +1. Press **File** > **Import** Menu item +2. In new dialog Select **Maven** > **Existing Maven Projects** +3. Press *Next* + + ![Import existing projects into Eclipse](../eclipse-import-existing-projects.png) + +4. In **Select root directory** field enter the location of your source code: + + * `C:\dev\geonetwork\trunk` + +5. Select All projects and Press **Finish** button. + +6. During the import process Eclipse will attempt to map each maven plugin to matching + functionality provided by the Eclipse IDE. + + If another window appears showing these associations, just continue without changing any option. + +7. It will take some minutes while the m2e plugin downloads all the Maven dependencies. + +## Building + +The Eclispe IDE is configured to respect the `src` and `target` locations defined by the maven `pom.xml` file. + +* Eclipse makes use of an incremental compiler, allowing classes to be changed during debugging sessions. + +* If you build on the command line, be sure to run a clean build in Eclipse when switching back to the IDE. + +## Running with Jetty + +Use **Run As** > **Maven Build** to use `jetty:run` from inside Eclipse. + +You can add some maven variables to be able to run in parallel a debug watch to debug your code. + +## Debugging with JRebel Plugin + +Using the [JRebel plugin](http://zeroturnaround.com/software/jrebel/) is very useful for debugging in Eclipse. + +An example of the configuration file for JRebel may be the following: + +```xml + + + + + + + + + + + + + + + + + + + + + + + +``` + +## Debugging with Tomcat Server + +The Eclipse for [Web Tools Project](https://www.eclipse.org/webtools/) includes a +Tomcat Plugin for controlling a Tomcat Service. + +#. Create a new Tomcat Server on Eclipse and add the geonetwork-main project as a web project. + +## Remote Debugging + +* [How do I configure Tomcat to support remote debugging?](http://wiki.apache.org/tomcat/FAQ/Developing#Q1) +* [How do I remotely debug Tomcat using Eclipse?](http://wiki.apache.org/tomcat/FAQ/Developing#Q2) + +## Code Quality Tools in Eclipse + +In order to see the same code quality warnings in Eclipse as Maven will detect, Find Bugs and Checkstyle +need to be installed in your Eclipse install and configured as follows:: + +* Start Eclipse +* Go to **Help > Eclipse Marketplace** + * Install **findbugs** + * Don't Restart + * Install **checkstyle** + * Now Restart +* Open preferences **Window > Preferences** + * Select *Java > Code Style > Code Templates* + * Select both Comments and Code elements + * Click **Import** and import **code_quality/codetemplates.xml** + * Select **Java > Code Style > Formatter** + * Click **Import** and import **code_quality/formatter.xml** + * Select **Java > Code Style > Clean Up** + * Click **Import** and import **code_quality/cleanup.xml** + * Select **Checkstyle** + * Click **New** + * Select **External Configuration** + * Enter any name (IE GeoNetwork) + * For **location** choose **code_quality/checkstyle_checks.xml** + * Press *OK* + * Select New configuration + * Press *Set as Default* + * Select **Java > FindBugs** + * Set **analysis effort** to **Maximum** + * Set **Minimum rank to report** to **2** + * Set **Minimum confidence to report** to **Medium** + * Check(enable) all bug categories + * Set all **Mark bugs with ... rank as** to **Warning** + * Change to _Filter files_ tab + * Add **code_quality/findbugs-excludes.xml** file to the **Exclude filter files** + * Close Preferences + * Right click on project in **Projects View** select **Checkstyle > Activate Checkstyle** + * Rebuild full project ( **Project > Clean...** ) + * Checkstyle violations will show up as warnings + * Right click on project in **Projects View** select **Find Bugs > Find Bugs** + * FindBugs violations will show up as warnings + +## Code Quality Tools and Maven + +During the build process FindBugs and Checkstyle are executed. If a violation is found then the build will fail. Usually the easiest way of resolving violations are to use Eclipse and run Checkstyle or FindBugs on the class or project with the failure. +Usually a detailed report will be provided in Eclipse along with suggested fixes. If the violation is determined to be an intentional violation the **code_quality/findbugs-excludes.xml** or **code_quality/checkstyle_suppressions.xml** should be updated to suppress the reporting of the violation. (See FindBugs and Checkstyle sections for more details.) + +Since the FindBugs and Checkstyle processes can be quite time consuming, adding -DskipTests to the maven commandline will skip those processes as well as tests. +For example: + +```bash +mvn install -DskipTests +``` + +Or if you want to run the tests but skip static analysis: + +```bash +mvn install -P-run-static-analysis +``` + +That disables the profile that executes the static analysis tasks. + +### FindBugs + +FindBugs is a tool that statically analyzes Java class files and searches for potential bugs. It excels at finding issues like unclosed reasources, inconsistent locking of resources, refering null known null-values. It also checks for bad practices like using default platform charset instead of an explicit charset. + +Because bad practices are checked for, sometimes FindBugs detects issues that are intentional. In order to account for these intentional violations FindBugs has exclude filter files which contain rules for violations that should be ignored. +In GeoNetwork the excludes filter file can be found at **/code_quality/findbugs-excludes.xml**. + +For complete details of how to specify matches in the excludes file see http://findbugs.sourceforge.net/manual/filter.html and look at the existing examples in the file. + +The Maven build will fail if any violations are detected so it is important to run FindBugs on each project and fix or exclude each violation that is reported. + +## FindBugs Annotations (JSR 305) + +In order to get the maximum benefit from the FindBugs (and Eclipse) analysis the javax.annotation annotations can be used to add metadata to methods, fields and parameters. The most commonly used annotations are @CheckForNull and @Nonnull. These +can be used on a parameter or return value to indicate that the parameter or return value must not be null or may be null. The FindBugs process will enforce these conditions and statically check that null is only ever correctly returned (in the case of return values) or passed to a method (in the case of parameters). + +Some resources for these annotations are: + +* http://vard-lokkur.blogspot.ch/2012/03/findbugs-and-jsr-305.html +* http://www.infoq.com/news/2008/06/jsr-305-update +* http://www.klocwork.com/blog/static-analysis/jsr-305-a-silver-bullet-or-not-a-bullet-at-all/ +* http://minds.coremedia.com/2012/10/31/jsr-305-nonnull-and-guava-preconditions/ +* http://findbugs.sourceforge.net/manual/annotations.html (the package names are out of date and should be java.annotation instead of edu.umd.cs.findbugs.annotation but the descriptions are accurate) diff --git a/software_development/GITHUB.md b/software_development/GITHUB.md new file mode 100644 index 00000000000..870aaf52de6 --- /dev/null +++ b/software_development/GITHUB.md @@ -0,0 +1,36 @@ +# GitHub + +## Forks, Pull requests and branches + +If you want to contribute back to GeoNetwork you create a Github account, fork the GeoNetwork repository and work on your fork. This is a huge benefit because you can push your changes to your repository as much as you want and when a feature is complete you can make a 'Pull Request'. Pull requests are the recommended method of contributing back to GeoNetwork because Github has code review tools and merges are much easier than trying to apply a patch attached to a ticket. + +The GeoNetwork Repository is at: https://github.com/geonetwork/core-geonetwork. + +Follow the instructions on the Github website to get started (make accounts, how to fork etc...) + +* http://help.github.com/ + +If you cloned the GeoNetwork Repository earlier, you set you can now set your fork up as a remote and begin to work. + +Rename the GeoNetwork repository as ``upstream``: + + git remote rename origin upstream + +Add your fork as origin (the URL provided by GitHub CLONE or DOWNLOAD button): + + git remote add origin https://github.com/USERNAME/core-geonetwork.git + +List remotes showing ``origin`` and ``upstream``: + + git remote -v + +To checkout a branch from upstream:: + + git checkout -t upstream/3.6.x + +## Pull Requests + +GeoNetwork uses feature branches for development, and a pull-request workflow for review: + +* [Contributing](../CONTRIBUTING.md). +* [Making a pull request](https://geonetwork-opensource.org/manuals/trunk/en/contributing/making-a-pull-request.html). diff --git a/software_development/INTELIJ.md b/software_development/INTELIJ.md new file mode 100644 index 00000000000..c2bad097e5d --- /dev/null +++ b/software_development/INTELIJ.md @@ -0,0 +1,70 @@ +# IntelliJ IDE + +JetBrains provide a the IntelliJ IDE, a community edition is available and +is documented here. + +This IDE is recommended for excellent Maven integration, and very fast build times. +It is especially good at working with large multi-module projects such as GeoNetwork. + +## Setting up + +1. Open project in IntelliJ, it will create an `.idea` folder (which is covered by `.gitignore`) + +2. Use *File* > *Project Structure* to confirm Java 8 is used + +4. Configuration to make *Maven* tools window easier to follow: + + * *Group Modules* + * *Always Show ArtifactId* + + ![configuration](intelij-maven-config.png) + +5. Use the *Maven* tools window to: + + * Enable the `env-dev` profile + * *Toggle "Skip Tests" Mode* + * *Execute Maven Goal*: `clean install` + + ![env-dev profile](intelij-maven-env-dev-profile.png) + +## Building + +1. After doing the maven build once, select menu *Build* > *Build Project*. + +2. The build progress is shown in the *Build* tools window. + +3. This is an incremental build, so only modified files are compiled in the future. + +## Running + +1. Menu *Run* > *Edit Configurations...* + +2. Add new *Maven* configuration: + + * Working Directory: `core-geonetwork/web` + + * Command Line: `jetty:run` + + * Profiles: `env-dev` + + ![maven run configuration](intelij-maven-configuration.png) + +3. Add maven goal `proccess-resources` before launch. + + ![maven process-resources goal](intelij-maven-resources.png) + +4. Run + +5. Testing + + * http://localhost:8080/geonetwork + * user: admin + * password: admin + +6. Live debugging + + * Debug using the run configuration created above + * The `env-dev` allows updates while running + * Use *Build Project* to compile, allowing methods to be rewritten interactively. + * Use *Maven* tool window to run `mvn process-resources` to + copy changes into the running web application. diff --git a/software_development/OVERVIEW.md b/software_development/OVERVIEW.md new file mode 100644 index 00000000000..377766850f1 --- /dev/null +++ b/software_development/OVERVIEW.md @@ -0,0 +1,27 @@ +# GeoNetwork Architecture Overview + +GeoNetwork is a modular application, managed using the spring framework, divided into clear application tiers. + +![GeoNetwork Architecture](geonetwork-architecture.png "GeoNetwork Architecture") + +GeoNetwork uses a wide range of technologies: + +* [Angular](https://angular.io/) web framwork providing model-view-controller architecture with data model binding +* [Apache Lucene](https://lucene.apache.org) text index to facilitate searching +* [Bootstrap](https://getbootstrap.com/) front-end open source toolkit providing response page layout +* [Elasticsearch](https://www.elastic.co/elasticsearch/) to manage usage statistics and reporting +* [GeoTools](https://geotools.org/) Java GIS toolkit used to provide a spatial index +* [OpenLayers](http://openlayers.org) web mapping framework +* [Saxxon](http://www.saxonica.com/) XSLT engine used extensively to process XML documents +* [Spring framework](https://spring.io/) Java web application framework used to "wire" components together + +GeoNetwork is Java Web Application, requiring an application server to operate: + +* [Jetty](https://www.eclipse.org/jetty/) application server for standaline distribution +* [Apache Tomcat](http://tomcat.apache.org/) application server for WAR distribution + +GeoNetwork configuration is managed via: + +* Configuration is managed via [Hibernate Object/Relational Mapping](https://hibernate.org/orm/) with [H2 Database Engine](https://www.h2database.com/) default for local testing, [PostgreSQL](https://www.postgresql.org/) recommended for production. Additional dialects are available for environments restricted to Oracle or SQLServer. + +* Data Directory for the management of thumbnails, attachments and other application files diff --git a/software_development/README.md b/software_development/README.md index 5389d6b3b7e..c5139b158cd 100644 --- a/software_development/README.md +++ b/software_development/README.md @@ -1,199 +1,38 @@ -# Software development +# Software Development -As the title of this document says, this manual is for software developers that want to -customize or develop GeoNetwork themselves. If you just want to use the software and are -looking for instructions on how to do that, there is a lot of documentation for users, -administrators, metadata editors and application maintainers at -http://geonetwork-opensource.org/manuals/trunk/eng/users/index.html +This manual is for software developers customizing or developing GeoNetwork: -## Build the application +* [GeoNetwork Architecture Overview](OVERVIEW.md) describing technologies used and application components. +* Development environment: -See [Installing from source code](https://geonetwork-opensource.org/manuals/trunk/en/maintainer-guide/installing/installing-from-source-code.html). + * [Tools](TOOLS.md) + * [Source code](SOURCE.md) + * [GitHub](GITHUB.md) + * [Building](BUILDING.md) + * [Testing](TESTING.md) + * [Eclipse IDE](ECLIPSE.md) + * [IntelliJ IDE](INTELIJ.md). + + See [Installing from source code](https://geonetwork-opensource.org/manuals/trunk/en/maintainer-guide/installing/installing-from-source-code.html) (Maintainer Guide) -## Build the documentation +* Writing documentation: see [Writing documentation](https://geonetwork-opensource.org/manuals/trunk/en/contributing/writing-documentation.html) (Contributing Guide). +* Release process: See [Doing a release](https://geonetwork-opensource.org/manuals/trunk/en/contributing/doing-a-release.html) (Contributing Guide). -See [Writing documentation](https://geonetwork-opensource.org/manuals/trunk/en/contributing/writing-documentation.html). -## Making a release +If you just want to use the software and are looking for instructions on how to do that, +there is a lot of documentation for users, administrators, metadata editors and application +maintainers at: [GeoNetwork Documentation](http://geonetwork-opensource.org/manuals/trunk/eng/users/index.html). -See [Doing a release](https://geonetwork-opensource.org/manuals/trunk/en/contributing/doing-a-release.html). +# Quickstart -# Eclipse setup +Get GeoNetwork running - the short path: -The easiest way to develop GeoNetwork within Eclipse is with [m2e plugin](http://eclipse.org/m2e/), -which comes by default on many Eclipse installations. - -## Import source code - -In order to import the source code, follow instructions below : - -* Press **File**> **Import** Menu item -* In new dialog Select **Maven**> **Existing Maven Projects** -* Press Next - -![Import existing projects into Eclipse](../eclipse-import-existing-projects.png) - -* In **Select root directory** field enter where your code is: - * example: C:\dev\geonetwork\trunk -* Select All projects and Press **Finish** button. If another window appears, just continue without changing any option. - -It will take some minutes while the m2e plugin downloads all the Maven dependencies. - -## Debugging inside Eclipse - -* JRebel Plugin : - -Using the [JRebel plugin](http://zeroturnaround.com/software/jrebel/) is very useful for debugging in Eclipse. - -An example of the configuration file for JRebel may be the following: - -```xml - - - - - - - - - - - - - - - - - - - - - - - -``` - -* Tomcat Server : - -Create a new Tomcat Server on Eclipse and add the geonetwork-main project as a web project. - -* Remote Debugging : - - * [How do I configure Tomcat to support remote debugging?](http://wiki.apache.org/tomcat/FAQ/Developing#Q1) - * [How do I remotely debug Tomcat using Eclipse?](http://wiki.apache.org/tomcat/FAQ/Developing#Q2) - -## Code Quality Tools in Eclipse - -In order to see the same code quality warnings in Eclipse as Maven will detect, Find Bugs and Checkstyle need to be installed in your Eclipse install and configured as follows:: - -* Start Eclipse -* Go to **Help > Eclipse Marketplace** - * Install **findbugs** - * Don't Restart - * Install **checkstyle** - * Now Restart -* Open preferences **Window > Preferences** - * Select *Java > Code Style > Code Templates* - * Select both Comments and Code elements - * Click **Import** and import **code_quality/codetemplates.xml** - * Select **Java > Code Style > Formatter** - * Click **Import** and import **code_quality/formatter.xml** - * Select **Java > Code Style > Clean Up** - * Click **Import** and import **code_quality/cleanup.xml** - * Select **Checkstyle** - * Click **New** - * Select **External Configuration** - * Enter any name (IE GeoNetwork) - * For **location** choose **code_quality/checkstyle_checks.xml** - * Press *OK* - * Select New configuration - * Press *Set as Default* - * Select **Java > FindBugs** - * Set **analysis effort** to **Maximum** - * Set **Minimum rank to report** to **2** - * Set **Minimum confidence to report** to **Medium** - * Check(enable) all bug categories - * Set all **Mark bugs with ... rank as** to **Warning** - * Change to _Filter files_ tab - * Add **code_quality/findbugs-excludes.xml** file to the **Exclude filter files** - * Close Preferences - * Right click on project in **Projects View** select **Checkstyle > Activate Checkstyle** - * Rebuild full project ( **Project > Clean...** ) - * Checkstyle violations will show up as warnings - * Right click on project in **Projects View** select **Find Bugs > Find Bugs** - * FindBugs violations will show up as warnings - -## Code Quality Tools and Maven - -During the build process FindBugs and Checkstyle are executed. If a violation is found then the build will fail. Usually the easiest way of resolving violations are to use Eclipse and run Checkstyle or FindBugs on the class or project with the failure. -Usually a detailed report will be provided in Eclipse along with suggested fixes. If the violation is determined to be an intentional violation the **code_quality/findbugs-excludes.xml** or **code_quality/checkstyle_suppressions.xml** should be updated to suppress the reporting of the violation. (See FindBugs and Checkstyle sections for more details.) - -Since the FindBugs and Checkstyle processes can be quite time consuming, adding -DskipTests to the maven commandline will skip those processes as well as tests. -For example: - -```bash -mvn install -DskipTests ``` - -Or if you want to run the tests but skip static analysis: - -```bash -mvn install -P-run-static-analysis +git clone --depth 3 --recursive https://github.com/geonetwork/core-geonetwork.git +cd core-geonetwork +mvn clean install -DskipTests +cd web +mvn jetty:run ``` -That disables the profile that executes the static analysis tasks. - -### FindBugs - -FindBugs is a tool that statically analyzes Java class files and searches for potential bugs. It excels at finding issues like unclosed reasources, inconsistent locking of resources, refering null known null-values. It also checks for bad practices like using default platform charset instead of an explicit charset. - -Because bad practices are checked for, sometimes FindBugs detects issues that are intentional. In order to account for these intentional violations FindBugs has exclude filter files which contain rules for violations that should be ignored. -In GeoNetwork the excludes filter file can be found at **/code_quality/findbugs-excludes.xml**. - -For complete details of how to specify matches in the excludes file see http://findbugs.sourceforge.net/manual/filter.html and look at the existing examples in the file. - -The Maven build will fail if any violations are detected so it is important to run FindBugs on each project and fix or exclude each violation that is reported. - -## FindBugs Annotations (JSR 305) - -In order to get the maximum benefit from the FindBugs (and Eclipse) analysis the javax.annotation annotations can be used to add metadata to methods, fields and parameters. The most commonly used annotations are @CheckForNull and @Nonnull. These -can be used on a parameter or return value to indicate that the parameter or return value must not be null or may be null. The FindBugs process will enforce these conditions and statically check that null is only ever correctly returned (in the case of return values) or passed to a method (in the case of parameters). - -Some resources for these annotations are: - -* http://vard-lokkur.blogspot.ch/2012/03/findbugs-and-jsr-305.html -* http://www.infoq.com/news/2008/06/jsr-305-update -* http://www.klocwork.com/blog/static-analysis/jsr-305-a-silver-bullet-or-not-a-bullet-at-all/ -* http://minds.coremedia.com/2012/10/31/jsr-305-nonnull-and-guava-preconditions/ -* http://findbugs.sourceforge.net/manual/annotations.html (the package names are out of date and should be java.annotation instead of edu.umd.cs.findbugs.annotation but the descriptions are accurate) - -### Forks, Pull requests and branches - -If you want to contribute back to GeoNetwork you create a Github account, fork the GeoNetwork repository and work on your fork. This is a huge benefit because you can push your changes to your repository as much as you want and when a feature is complete you can make a 'Pull Request'. Pull requests are the recommended method of contributing back to GeoNetwork because Github has code review tools and merges are much easier than trying to apply a patch attached to a ticket. - -The GeoNetwork Repository is at: https://github.com/geonetwork/core-geonetwork. - -Follow the instructions on the Github website to get started (make accounts, how to fork etc...) http://help.github.com/ - -If you cloned the GeoNetwork Repository earlier, you set you can now set your fork up as a remote and begin to work. - -Rename the GeoNetwork repository as ``upstream``: - - git remote rename origin upstream - -Add your fork as origin (the URL provided by GitHub CLONE or DOWNLOAD button): - - git remote add origin https://github.com/USERNAME/core-geonetwork.git - -List remotes showing ``origin`` and ``upstream``: - - git remote -v - -To checkout a branch from upstream:: - - git checkout -t upstream/3.6.x - -### Pull request - -See [Making a pull request](https://geonetwork-opensource.org/manuals/trunk/en/contributing/making-a-pull-request.html) - +The application is opened on http://localhost:8080/geonetwork diff --git a/software_development/SOURCE.md b/software_development/SOURCE.md new file mode 100644 index 00000000000..3160fee40d1 --- /dev/null +++ b/software_development/SOURCE.md @@ -0,0 +1,39 @@ +# Source Code + +## Check out source code + +Clone the repository: + +``` +git clone --recursive https://github.com/geonetwork/core-geonetwork.git +``` + +And build: + +``` +cd core-geonetwork +mvn clean install -DskipTests +``` + +Submodules +---------- + +GeoNetwork use submodules, these were initiziled by the ``--recursive`` option when cloning the repository. + +If you missed using ``--recursive`` run the following: + +.. code-block:: shell + + cd core-geonetwork + git submodule init + git submodule update + +Submodules are used to keep track of externals dependencies. It is necessary to init and update them after a branch change: + + +.. code-block:: shell + + git submodule update --init + + +Remember to rebuild the application after updating external dependencies. diff --git a/software_development/TESTING.md b/software_development/TESTING.md new file mode 100644 index 00000000000..cab17041498 --- /dev/null +++ b/software_development/TESTING.md @@ -0,0 +1,43 @@ +# Testing + +GeoNetwork is a standard Java project, primarily using on JUnit for testing. There is am important separation between unit tests and integration tests. + +## Unit Tests + +In Geonetwork *Unit Tests* should be very very quick to execute and not start up any subsystems of the application in order to keep +the execution time of the unit tests very short. + +Efficient Unit tests do not require super classes and any assistance methods can be static +imports, for example statically ``importing org.junit.Assert``` or ``org.junit.Assume``` or ``org.fao.geonet.Assert``. + +## Integration Tests + +*Integration Tests* typically start much or all of GeoNetwork as part of the test and will take longer to run than +a unit test. However, even though the tests take longer they should still be implemented in such a way to be as efficient as possible. + +Starting GeoNetwork in a way that isolates each integration test from each other integration test is non-trivial. Because of this +there are `abstract` super classes to assist with this. Many modules have module specific Abstract classes. For example `domain`, `core`, `harvesters` and `services` modules all have module specific super classes that need to be used. (`harvesting` has 2 superclasses depending on what is to be tested.) + +The easiest way to learn how to implement an integration test is to search for other integration tests in the same module as the class +you want to test. + +The following list provides a few tips: + +* *IMPORTANT*: All Integrations tests *must* end in `IntegrationTest`. The build system assumes all tests ending in `IntegrationTest` are + an integration test and runs them in a build phase after unit tests. All other tests are assumed to be unit tests. + +* Prefer Unit Tests over Integration Tests because they are faster. + +* Search the current module for an `IntegrationTest` to find tests to model your integration test against + +* Integration tests are used for testing: + + * Services: If the service already exists and you quick need to write a test to debug/fix its behaviour. + If you are writing a new service it is better to use Mockito to mock the dependencies of the service so the test is + a unit test. + * Harvesters + * A behaviour that crosses much of the full system + +* **org.fao.geonet.utils.GeonetHttpRequestFactory*: When making Http requests you should use `org.fao.geonet.utils.GeonetHttpRequestFactory` instead + of directly using `HttpClient`. This is because there are mock instances of `org.fao.geonet.utils.GeonetHttpRequestFactory` that can + be used to mock responses when performing tests. diff --git a/software_development/TOOLS.md b/software_development/TOOLS.md new file mode 100644 index 00000000000..30cfa311a13 --- /dev/null +++ b/software_development/TOOLS.md @@ -0,0 +1,42 @@ +# Tools + +GeoNetwork is a Java Web Application, developed using Java 8, Maven. + +Documentation makes use of the python Sphinx build system. + +## Git + +GeoNetwork uses [Git](https://git-scm.com/) version control. + +Our source code is maintained on GitHub: + +* [github.com/geonetwork](https://github.com/geonetwork): + + * [core-geonetwork](https://github.com/geonetwork/core-geonetwork) + * [doc](https://github.com/geonetwork/doc) + +* [github.com/metadata101](https://github.com/metadata101): + + * [iso19115-3.2018](https://github.com/metadata101/iso19115-3.2018) + +## Java 8 + +GeoNetwork requires a Java 8 development environment: + +* Recommend using the Java 8 distribution available from your operating system +* [Adopt OpenJDK8 (LTS)](https://adoptopenjdk.net/?variant=openjdk8) for windows or macOS installers + +We do not support development on Java 11 at this time. + +## Apache Maven + +We make use of the Apache Maven [Apache Maven](https://maven.apache.org/) build system. + +Maven repository is available at repo.osgeo.org: + +* https://repo.osgeo.org/repository/release/ +* https://repo.osgeo.org/repository/snapshot/ + +## Sphinx + +Documentation is built using [Sphinx](https://www.sphinx-doc.org/) python documentation generator. diff --git a/software_development/geonetwork-architecture.png b/software_development/geonetwork-architecture.png new file mode 100644 index 00000000000..1273d96d3f0 Binary files /dev/null and b/software_development/geonetwork-architecture.png differ diff --git a/software_development/intelij-maven-config.png b/software_development/intelij-maven-config.png new file mode 100644 index 00000000000..1322ac84883 Binary files /dev/null and b/software_development/intelij-maven-config.png differ diff --git a/software_development/intelij-maven-configuration.png b/software_development/intelij-maven-configuration.png new file mode 100644 index 00000000000..c2b6a049db3 Binary files /dev/null and b/software_development/intelij-maven-configuration.png differ diff --git a/software_development/intelij-maven-env-dev-profile.png b/software_development/intelij-maven-env-dev-profile.png new file mode 100644 index 00000000000..d2055fea2d1 Binary files /dev/null and b/software_development/intelij-maven-env-dev-profile.png differ diff --git a/software_development/intelij-maven-resources.png b/software_development/intelij-maven-resources.png new file mode 100644 index 00000000000..af2dbb23450 Binary files /dev/null and b/software_development/intelij-maven-resources.png differ