From 86ecdba4c8876441094a4bb7e6f685d7c5ab1d81 Mon Sep 17 00:00:00 2001 From: Jeffery To Date: Wed, 5 Jun 2019 03:43:37 +0800 Subject: [PATCH] initial commit --- .editorconfig | 16 ++ .gitattributes | 1 + .gitignore | 34 ++++ Changelog.md | 4 + LICENSE | 339 +++++++++++++++++++++++++++++++ README.md | 138 +++++++++++++ builder/Dockerfile | 43 ++++ builder/docker-entrypoint.sh | 60 ++++++ builder/docker-run.sh | 74 +++++++ docker-compose.yml | 80 ++++++++ sdk/bin/.gitkeep | 0 sdk/build_dir/.gitkeep | 0 sdk/clean.sh | 24 +++ sdk/dirclean.sh | 26 +++ sdk/distclean.sh | 30 +++ sdk/dl/.gitkeep | 0 sdk/feeds/.gitkeep | 0 sdk/logs/.gitkeep | 0 sdk/overrides/.gitkeep | 0 sdk/package/feeds/.gitkeep | 0 sdk/sdk/.gitkeep | 0 sdk/staging_dir/hostpkg/.gitkeep | 0 sdk/staging_dir/target/.gitkeep | 0 sdk/tmp/.gitkeep | 0 24 files changed, 869 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 Changelog.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 builder/Dockerfile create mode 100644 builder/docker-entrypoint.sh create mode 100644 builder/docker-run.sh create mode 100644 docker-compose.yml create mode 100644 sdk/bin/.gitkeep create mode 100644 sdk/build_dir/.gitkeep create mode 100644 sdk/clean.sh create mode 100644 sdk/dirclean.sh create mode 100644 sdk/distclean.sh create mode 100644 sdk/dl/.gitkeep create mode 100644 sdk/feeds/.gitkeep create mode 100644 sdk/logs/.gitkeep create mode 100644 sdk/overrides/.gitkeep create mode 100644 sdk/package/feeds/.gitkeep create mode 100644 sdk/sdk/.gitkeep create mode 100644 sdk/staging_dir/hostpkg/.gitkeep create mode 100644 sdk/staging_dir/target/.gitkeep create mode 100644 sdk/tmp/.gitkeep diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4200168 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,16 @@ +# editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_style = tab +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.yml] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ba78092 --- /dev/null +++ b/.gitignore @@ -0,0 +1,34 @@ +/packages/ + +/sdk/bin/* +!/sdk/bin/.gitkeep + +/sdk/build_dir/* +!/sdk/build_dir/.gitkeep + +/sdk/dl/* +!/sdk/dl/.gitkeep + +/sdk/feeds/* +!/sdk/feeds/.gitkeep + +/sdk/logs/* +!/sdk/logs/.gitkeep + +/sdk/overrides/* +!/sdk/overrides/.gitkeep + +/sdk/package/feeds/* +!/sdk/package/feeds/.gitkeep + +/sdk/sdk/* +!/sdk/sdk/.gitkeep + +/sdk/staging_dir/hostpkg/* +!/sdk/staging_dir/hostpkg/.gitkeep + +/sdk/staging_dir/target/* +!/sdk/staging_dir/target/.gitkeep + +/sdk/tmp/* +!/sdk/tmp/.gitkeep diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 0000000..de70d40 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,4 @@ +# Changelog + +## 0.1.0 (2019-06-05) +* Initial release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + 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/README.md b/README.md new file mode 100644 index 0000000..83151c6 --- /dev/null +++ b/README.md @@ -0,0 +1,138 @@ +# Vivarium + +Build OpenWrt packages using Docker and the OpenWrt SDK + +## Introduction + +Vivarium is a way to compile packages for +[OpenWrt](https://openwrt.org/) without having to install the necessary +[build +tools](https://openwrt.org/docs/guide-developer/build-system/install-buildsystem), +using [Docker](https://www.docker.com/). + +Vivarium includes a "builder" Dockerfile for a local Docker image, based +on the CircleCI Docker image used by the [OpenWrt packages +feed](https://github.com/openwrt/packages). This local image will have +the [OpenWrt +SDK](https://openwrt.org/docs/guide-developer/using_the_sdk) set up +inside. + +This also includes a Docker Compose file that holds all of the +configuration options. The Compose file also sets up a number of bind +mounts, allowing access to package source code from the Docker container +and access to build artifacts from the host machine. + +## Requirements + +[Docker](https://docs.docker.com/install/#supported-platforms) and +[Docker Compose](https://docs.docker.com/compose/install/) will need to +be installed. + +Vivarium has only been tested with Linux (Ubuntu 19.04, to be exact). +Testing with other platforms is welcome. + +## Getting started + +1. Download the source code and extract. + + If you will be using Git to manage your package source code, then + you will want to download Vivarium as a zip or tar.gz to avoid + nesting Git repositories. + +2. In the project directory, create a `packages` directory and add + source code for packages, e.g. by checking out the OpenWrt packages + feed: + + $ cd openwrt-vivarium + $ git clone https://github.com/openwrt/packages.git + +3. If you are using Linux and your user ID is not 1000, you will need + to change the ownership of the `packages` and `sdk` directories (and + all files and subdirectories inside) to UID 1000, e.g.: + + $ sudo chown -R 1000:1000 packages sdk + + These directories need to be readable and writable by the normal + user inside the Docker image (with UID 1000 / GID 1000). + +4. Build packages by using `docker-compose run`, e.g.: + + $ sudo docker-composer run --rm builder make package/python/compile V=s + + If the build was successful, the compiled package(s) will be in the + `sdk/bin` directory. + +## Configuration + +All options can be found in the `docker-compose.yml` file. + +### Image build options + +* `SDK_HOST`, `SDK_PATH`, `SDK_FILE`: Which SDK to use + + If there is an SDK archive (matching `SDK_FILE`) in the `sdk/sdk` + directory, then it will be used instead of downloading the archive + from `SDK_HOST`. + +* `BRANCH`: Which branch to use when setting up package feeds, e.g. + `master`, `openwrt-18.06`, etc. + +* `CUSTOM_FEED`: Controls how the `packages` directory is used + * `n`: The directory is added as the "packages" feed, in + place of the OpenWrt packages feed + * `y`: The directory is added as a custom feed (the OpenWrt + packages feed will be present as well) + +### Run-time options + +* `KEEP_SDK_FILE`: If `y`, the SDK archive within the Docker image + will be copied to the `sdk/sdk` directory when the builder is run + +* `CONFIG_AUTOREMOVE`, `CONFIG_BUILD_LOG`: Sets the corresponding SDK + config options (`y` or `n`) + +## Rebuild local Docker image + +To change SDKs or update to the latest snapshot SDK, the local Docker +image will need to be rebuilt. + +If `KEEP_SDK_FILE` is `y`, it may be necessary clear the `sdk/sdk` +directory first to ensure a new SDK archive is downloaded: + + $ rm -f sdk/sdk/* + +Then rebuild the image: + + $ sudo docker-compose build + +The `--no-cache` option may be needed to force a rebuild / re-download. + +## Directory cleaning + +The SDK commands for directory cleaning (`make clean`, `make dirclean`, +etc.) are not aware of the Docker bind mounts and so may not work +correctly. + +There are scripts in the `sdk` directory (`clean.sh`, `dirclean.sh`, +`distclean.sh`) that emulate the SDK commands and can be run from the +host. + +## License + +Copyright (C) 2019 Jeffery To +https://github.com/jefferyto/openwrt-vivarium + +Vivarium is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 as +published by the Free Software Foundation. + +Vivarium 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 Vivarium. If not, see . + +Contains code from .circleci/config.yml of the OpenWrt packages feed +Copyright (C) 2018 Etienne Champetier, Ted Hess diff --git a/builder/Dockerfile b/builder/Dockerfile new file mode 100644 index 0000000..ed49a0f --- /dev/null +++ b/builder/Dockerfile @@ -0,0 +1,43 @@ +# +# Dockerfile +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +FROM docker.io/openwrtorg/packages-cci:v1.0.2 + +ARG SDK_HOST +ARG SDK_PATH +ARG SDK_FILE +ARG BRANCH +ARG CUSTOM_FEED + +ENV SDK_HOST=$SDK_HOST +ENV SDK_PATH=$SDK_PATH +ENV SDK_FILE=$SDK_FILE +ENV BRANCH=$BRANCH +ENV CUSTOM_FEED=$CUSTOM_FEED + +WORKDIR /home/build + +COPY builder/docker-run.sh sdk/sdk/$SDK_FILE / + +RUN sh -e /docker-run.sh + +COPY builder/docker-entrypoint.sh / + +ENTRYPOINT [ "sh", "-e", "/docker-entrypoint.sh" ] diff --git a/builder/docker-entrypoint.sh b/builder/docker-entrypoint.sh new file mode 100644 index 0000000..be574d0 --- /dev/null +++ b/builder/docker-entrypoint.sh @@ -0,0 +1,60 @@ +#!/bin/sh -e +# +# docker-entrypoint.sh +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +cd $HOME + +if [ "$KEEP_SDK_FILE" = y ] && [ -d sdk ]; then + cp -np $SDK_FILE sdk/ +fi + +cd build_dir + +mkdir -p build_dir +for path in build_dir_default/*; do + if [ ! -d build_dir/$(basename $path) ]; then + cp -pr $path build_dir/ + fi +done + +sed -i \ + -e "/\s*config AUTOREMOVE$/{n;n;s/default [yn]/default ${CONFIG_AUTOREMOVE:-y}/}" \ + -e "/\s*config BUILD_LOG$/{n;n;s/default [yn]/default ${CONFIG_BUILD_LOG:-n}/}" \ + Config.in + +if [ -d ../overrides ] && [ -n "$(find ../overrides -mindepth 1 -maxdepth 1 \! -path '*/.*' -name '*' -print -quit)" ]; then + cp -fpr ../overrides/* ./ +fi + +./scripts/feeds update -a +./scripts/feeds install -a + +if [ -f diffconfig ]; then + cp -f diffconfig .config +fi + +make defconfig + +mkdir -p logs +cp -f .config logs/config + +if [ $# -gt 0 ]; then + "$@" +fi diff --git a/builder/docker-run.sh b/builder/docker-run.sh new file mode 100644 index 0000000..03af374 --- /dev/null +++ b/builder/docker-run.sh @@ -0,0 +1,74 @@ +#!/bin/sh -e +# +# docker-run.sh +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +# +# Contains code from .circleci/config.yml of the OpenWrt packages feed +# Copyright (C) 2018 Etienne Champetier, Ted Hess +# + +cd $HOME + +if [ -z "$(find / -mindepth 1 -maxdepth 1 -name "$SDK_FILE" -print -quit)" ]; then + echo "Download the SDK" + + mkdir sdk_dl + cd sdk_dl + + # From https://github.com/openwrt/packages/blob/master/.circleci/config.yml + curl "https://$SDK_HOST/$SDK_PATH/sha256sums" -sS -o sha256sums + curl "https://$SDK_HOST/$SDK_PATH/sha256sums.asc" -sS -o sha256sums.asc + gpg --with-fingerprint --verify sha256sums.asc sha256sums + rsync -av "$SDK_HOST::downloads/$SDK_PATH/$SDK_FILE" . + sha256sum -c --ignore-missing sha256sums + + cd .. + ln -s sdk_dl/$SDK_FILE ./ + +else + echo "Use saved SDK" + + ln -s /$SDK_FILE ./ +fi + +echo "Prepare build_dir" + +mkdir build_dir +cd build_dir + +tar Jxf ../$SDK_FILE --strip=1 + +mv build_dir build_dir_default + +mkdir staging_dir/target +for path in build_dir_default/target-*; do + ln -s target staging_dir/$(basename $path) +done + +echo "src-git base https://github.com/openwrt/openwrt.git;$BRANCH" > feeds.conf +if [ "$CUSTOM_FEED" = y ]; then + echo "src-git packages https://github.com/openwrt/packages.git;$BRANCH" >> feeds.conf + echo "src-link custom $HOME/openwrt_packages" >> feeds.conf +else + echo "src-link packages $HOME/openwrt_packages" >> feeds.conf +fi +echo "src-git luci https://github.com/openwrt/luci.git;$BRANCH" >> feeds.conf + +cat feeds.conf diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..b57c42b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,80 @@ +# +# docker-compose.yml +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +version: "3" + +services: + builder: + build: + context: . + dockerfile: builder/Dockerfile + args: + # Which SDK to use + # If an SDK archive (matching SDK_FILE) is in the "sdk/sdk" + # directory, it will be used instead of downloading the archive + # from SDK_HOST + SDK_HOST: downloads.openwrt.org + SDK_PATH: snapshots/targets/ath79/generic + SDK_FILE: openwrt-sdk-ath79-generic_*.Linux-x86_64.tar.xz + + # Which branch to use when setting up package feeds, e.g. + # master, openwrt-18.06, etc. + BRANCH: master + + # Controls how the "packages" directory is used + # - n: The directory is added as the "packages" feed, in place + # of the OpenWrt packages feed + # - y: The directory is added as a custom feed (the OpenWrt + # packages feed will be present as well) + CUSTOM_FEED: n + + environment: + # If y, the SDK archive within the Docker image will be copied to + # the "sdk/sdk" directory when the builder is run + KEEP_SDK_FILE: n + + # Sets the corresponding config options (y or n) + CONFIG_AUTOREMOVE: y + CONFIG_BUILD_LOG: n + + volumes: + # Where modified/custom packages should be placed; + # if CUSTOM_FEED is n, this should be a copy of the OpenWrt + # packages feed (https://github.com/openwrt/packages) + - "./packages:/home/build/openwrt_packages" + + # Where the SDK archive is loaded from and/or saved to + - "./sdk/sdk:/home/build/sdk" + + # Contains build artifacts + - "./sdk/bin:/home/build/build_dir/bin" + - "./sdk/build_dir:/home/build/build_dir/build_dir" + - "./sdk/dl:/home/build/build_dir/dl" + - "./sdk/feeds:/home/build/build_dir/feeds" + - "./sdk/logs:/home/build/build_dir/logs" + - "./sdk/package/feeds:/home/build/build_dir/package/feeds" + - "./sdk/staging_dir/hostpkg:/home/build/build_dir/staging_dir/hostpkg" + - "./sdk/staging_dir/target:/home/build/build_dir/staging_dir/target" + - "./sdk/tmp:/home/build/build_dir/tmp" + + # Files in overrides will be copied into the sdk/build directory + # directly; if there is a file named "diffconfig", it will be + # copied to ".config", then expanded by "make defconfig" + - "./sdk/overrides:/home/build/overrides" diff --git a/sdk/bin/.gitkeep b/sdk/bin/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/build_dir/.gitkeep b/sdk/build_dir/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/clean.sh b/sdk/clean.sh new file mode 100644 index 0000000..4f2a3e7 --- /dev/null +++ b/sdk/clean.sh @@ -0,0 +1,24 @@ +#!/bin/sh -e +# +# clean.sh +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +[ "${0%/*}" = . ] || exit 1 + +rm -rf build_dir/target-* staging_dir/target/* bin/* logs/* diff --git a/sdk/dirclean.sh b/sdk/dirclean.sh new file mode 100644 index 0000000..c584ae2 --- /dev/null +++ b/sdk/dirclean.sh @@ -0,0 +1,26 @@ +#!/bin/sh -e +# +# dirclean.sh +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +[ "${0%/*}" = . ] || exit 1 + +. ./clean.sh + +rm -rf build_dir/hostpkg staging_dir/hostpkg/* diff --git a/sdk/distclean.sh b/sdk/distclean.sh new file mode 100644 index 0000000..90f7dbd --- /dev/null +++ b/sdk/distclean.sh @@ -0,0 +1,30 @@ +#!/bin/sh -e +# +# distclean.sh +# This file is part of Vivarium. +# +# Copyright (C) 2019 Jeffery To +# https://github.com/jefferyto/openwrt-vivarium +# +# Vivarium is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# Vivarium 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 Vivarium. If not, see . +# + +[ "${0%/*}" = . ] || exit 1 + +. ./dirclean.sh + +rm -rf feeds/* package/feeds/* +rm -rf dl/* sdk/* +rm -rf tmp/..?* tmp/.[!.]* tmp/* + +touch tmp/.gitkeep diff --git a/sdk/dl/.gitkeep b/sdk/dl/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/feeds/.gitkeep b/sdk/feeds/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/logs/.gitkeep b/sdk/logs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/overrides/.gitkeep b/sdk/overrides/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/package/feeds/.gitkeep b/sdk/package/feeds/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/sdk/.gitkeep b/sdk/sdk/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/staging_dir/hostpkg/.gitkeep b/sdk/staging_dir/hostpkg/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/staging_dir/target/.gitkeep b/sdk/staging_dir/target/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/tmp/.gitkeep b/sdk/tmp/.gitkeep new file mode 100644 index 0000000..e69de29