├── .github └── workflows │ └── build-test-deploy.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── build-and-test.sh ├── deploy.sh ├── distro-entry.sh ├── poky-entry.py ├── poky-launch.sh ├── sudoers.usersetup └── tests ├── check-path.sh ├── check_args.py ├── distro-check.sh ├── run-build.sh ├── run-dumb-init-check.sh ├── run-workdir-check.sh └── runtests.sh /.github/workflows/build-test-deploy.yml: -------------------------------------------------------------------------------- 1 | name: poky-container build and test 2 | on: 3 | push: 4 | branches: 5 | - master 6 | pull_request: 7 | 8 | # Allow for manually running 9 | workflow_dispatch: 10 | 11 | # Run at 01:42 UTC every Saturday 12 | schedule: 13 | - cron: '42 1 * * 6' 14 | 15 | jobs: 16 | build-test-deploy: 17 | runs-on: ubuntu-latest 18 | permissions: 19 | packages: write 20 | strategy: 21 | fail-fast: false 22 | matrix: 23 | base_distro: [ 24 | alma-8, 25 | alma-9, 26 | debian-10, 27 | debian-11, 28 | debian-12, 29 | fedora-39, 30 | fedora-40, 31 | opensuse-15.4, 32 | opensuse-15.5, 33 | opensuse-15.6, 34 | ubuntu-18.04, 35 | ubuntu-20.04, 36 | ubuntu-22.04 37 | ] 38 | env: 39 | BASE_DISTRO: ${{ matrix.base_distro }} 40 | REPO: crops/poky 41 | DEFAULT_DISTRO: ubuntu-18.04 42 | DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }} 43 | DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }} 44 | GHCR_USERNAME: ${{ github.actor }} 45 | GHCR_PASSWORD: ${{ secrets.GITHUB_TOKEN }} 46 | 47 | steps: 48 | - uses: actions/checkout@v4 49 | 50 | # Build and test the images 51 | - name: Run build-and-test.sh 52 | run: ./build-and-test.sh 53 | 54 | # Deploy the images 55 | - name: Deploy 56 | run: bash deploy.sh 57 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.pyo 3 | *.orig 4 | *.rej 5 | *~ 6 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2015-2016 Intel Corporation 2 | # 3 | # This program is free software; you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License version 2 as 5 | # published by the Free Software Foundation. 6 | # 7 | # This program is distributed in the hope that it will be useful, 8 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | # GNU General Public License for more details. 11 | # 12 | # You should have received a copy of the GNU General Public License along 13 | # with this program; if not, write to the Free Software Foundation, Inc., 14 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15 | 16 | # Since this Dockerfile is used in multiple images, force the builder to 17 | # specify the BASE_DISTRO. This should hopefully prevent accidentally using 18 | # a default, when another distro was desired. 19 | ARG BASE_DISTRO=SPECIFY_ME 20 | 21 | FROM crops/yocto:$BASE_DISTRO-base 22 | 23 | USER root 24 | 25 | ADD https://raw.githubusercontent.com/crops/extsdk-container/master/restrict_useradd.sh \ 26 | https://raw.githubusercontent.com/crops/extsdk-container/master/restrict_groupadd.sh \ 27 | https://raw.githubusercontent.com/crops/extsdk-container/master/usersetup.py \ 28 | /usr/bin/ 29 | COPY distro-entry.sh poky-entry.py poky-launch.sh /usr/bin/ 30 | COPY sudoers.usersetup /etc/ 31 | 32 | # For ubuntu, do not use dash. 33 | RUN which dash &> /dev/null && (\ 34 | echo "dash dash/sh boolean false" | debconf-set-selections && \ 35 | DEBIAN_FRONTEND=noninteractive dpkg-reconfigure dash) || \ 36 | echo "Skipping dash reconfigure (not applicable)" 37 | 38 | # We remove the user because we add a new one of our own. 39 | # The usersetup user is solely for adding a new user that has the same uid, 40 | # as the workspace. 70 is an arbitrary *low* unused uid on debian. 41 | RUN userdel -r yoctouser && \ 42 | mkdir /home/yoctouser && \ 43 | groupadd -g 70 usersetup && \ 44 | useradd -N -m -u 70 -g 70 usersetup && \ 45 | chmod 755 /usr/bin/usersetup.py \ 46 | /usr/bin/poky-entry.py \ 47 | /usr/bin/poky-launch.sh \ 48 | /usr/bin/restrict_groupadd.sh \ 49 | /usr/bin/restrict_useradd.sh && \ 50 | echo "#include /etc/sudoers.usersetup" >> /etc/sudoers 51 | 52 | USER usersetup 53 | ENV LANG=en_US.UTF-8 54 | 55 | ENTRYPOINT ["/usr/bin/distro-entry.sh", "/usr/bin/dumb-init", "--", "/usr/bin/poky-entry.py"] 56 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Poky Container 2 | ======================== 3 | This repo is to create an image that is able to run bitbake/poky. The main 4 | difference between it and https://github.com/crops/yocto-dockerfiles is that 5 | it has helpers to create users and groups within the container. This is so that 6 | the output generated in the container will be readable by the user on the 7 | host. 8 | 9 | The instructions will be slightly different depending on whether Linux, Windows or Mac is used. There are setup instructions for using **Windows/Mac** at https://github.com/crops/docker-win-mac-docs/wiki. When referring to **Windows/Mac** in the rest of the document, it is assumed the instructions at https://github.com/crops/docker-win-mac-docs/wiki were followed. 10 | 11 | Running the container 12 | --------------------- 13 | Here a very simple but usable scenario for using the container is described. 14 | It is by no means the *only* way to run the container, but is a great starting 15 | point. 16 | 17 | * **Create a workdir or volume** 18 | * **Linux** 19 | 20 | The workdir you create will be used for the output created while using the container. 21 | For example a user could create a directory using the command 22 | 23 | ``` 24 | mkdir -p /home/myuser/mystuff 25 | ``` 26 | 27 | *It is important that you are the owner of the directory.* The owner of the 28 | directory is what determines the user id used inside the container. If you 29 | are not the owner of the directory, you may not have access to the files the 30 | container creates. 31 | 32 | For the rest of the Linux instructions we'll assume the workdir chosen was 33 | `/home/myuser/mystuff`. 34 | 35 | * **Windows/Mac** 36 | 37 | On Windows or Mac a workdir isn't needed. Instead the volume called *myvolume* will be used. This volume should have been created when following the instructions at https://github.com/crops/docker-win-mac-docs/wiki. 38 | 39 | 40 | * **The docker command** 41 | * **Linux** 42 | 43 | Assuming you used the *workdir* from above, the command 44 | to run a container for the first time would be: 45 | 46 | ``` 47 | docker run --rm -it -v /home/myuser/mystuff:/workdir crops/poky --workdir=/workdir 48 | ``` 49 | or, if you have SELinux in enforcing mode: 50 | ``` 51 | docker run --rm -it -v /home/myuser/mystuff:/workdir:Z crops/poky --workdir=/workdir 52 | ``` 53 | 54 | * **Windows/Mac** 55 | 56 | ``` 57 | docker run --rm -it -v myvolume:/workdir crops/poky --workdir=/workdir 58 | ``` 59 | 60 | Let's discuss the options: 61 | * **_--workdir=/workdir_**: This causes the container to start in the directory 62 | specified. This can be any directory in the container. The container will also use the uid and gid 63 | of the workdir as the uid and gid of the user in the container. 64 | 65 | This should put you at a prompt similar to: 66 | ``` 67 | pokyuser@3bbac563cacd:/workdir$ 68 | ``` 69 | At this point you should be able to follow the same instructions as described 70 | in https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html 71 | -------------------------------------------------------------------------------- /build-and-test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Copyright (C) 2016 Intel Corporation 3 | # 4 | # This program is free software; you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 2 as 6 | # published by the Free Software Foundation. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along 14 | # with this program; if not, write to the Free Software Foundation, Inc., 15 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 16 | # 17 | set -e 18 | 19 | # Allow the user to specify another command to use for building such as podman. 20 | if [ "${ENGINE_CMD}" = "" ]; then 21 | ENGINE_CMD="docker" 22 | fi 23 | 24 | ${ENGINE_CMD} build --build-arg BASE_DISTRO=${BASE_DISTRO} --pull -t ${REPO}:${BASE_DISTRO} . 25 | 26 | if command -v annotate-output; then 27 | ANNOTATE_OUTPUT=annotate-output 28 | fi 29 | $ANNOTATE_OUTPUT bash -c "cd tests; ./runtests.sh ${REPO}:${BASE_DISTRO}" 30 | 31 | rm -f $DOCKERFILE 32 | -------------------------------------------------------------------------------- /deploy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Copyright (C) 2016 Intel Corporation 3 | # Copyright (C) 2024 Konsulko Group 4 | # 5 | # SPDX-License-Identifier: GPL-2.0-only 6 | # 7 | # This script is meant to be consumed by travis. It's very simple but running 8 | # a loop in travis.yml isn't a great thing. 9 | set -e 10 | 11 | # Allow the user to specify another command to use for building such as podman. 12 | if [ "${ENGINE_CMD}" = "" ]; then 13 | ENGINE_CMD="docker" 14 | fi 15 | 16 | # Don't deploy on pull requests because it could just be junk code that won't 17 | # get merged 18 | if ([ "${GITHUB_EVENT_NAME}" = "push" ] || [ "${GITHUB_EVENT_NAME}" = "workflow_dispatch" ] || [ "${GITHUB_EVENT_NAME}" = "schedule" ]) && [ "${GITHUB_REF}" = "refs/heads/master" ]; then 19 | echo $DOCKER_PASSWORD | ${ENGINE_CMD} login -u $DOCKER_USERNAME --password-stdin 20 | ${ENGINE_CMD} push ${REPO}:${BASE_DISTRO} 21 | 22 | if [ "${DEFAULT_DISTRO}" = "${BASE_DISTRO}" ]; then 23 | ${ENGINE_CMD} tag ${REPO}:${BASE_DISTRO} ${REPO}:latest 24 | ${ENGINE_CMD} push ${REPO}:latest 25 | fi 26 | 27 | ${ENGINE_CMD} tag ${REPO}:${BASE_DISTRO} ghcr.io/${REPO}:${BASE_DISTRO} 28 | 29 | echo $GHCR_PASSWORD | ${ENGINE_CMD} login ghcr.io -u $GHCR_USERNAME --password-stdin 30 | ${ENGINE_CMD} push ghcr.io/${REPO}:${BASE_DISTRO} 31 | 32 | if [ "${DEFAULT_DISTRO}" = "${BASE_DISTRO}" ]; then 33 | ${ENGINE_CMD} tag ${REPO}:${BASE_DISTRO} ghcr.io/${REPO}:latest 34 | ${ENGINE_CMD} push ghcr.io/${REPO}:latest 35 | fi 36 | 37 | else 38 | echo "Not pushing since build was triggered by a pull request." 39 | fi 40 | -------------------------------------------------------------------------------- /distro-entry.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Copyright (C) 2019 Intel Corporation 3 | # Copyright (C) 2022 Konsulko Group 4 | # 5 | # SPDX-License-Identifier: GPL-2.0-only 6 | 7 | RELEASE="4.1" 8 | 9 | # This entry point is so that we can do distro specific changes to the launch. 10 | if [ "$(uname -m)" = "aarch64" ]; then 11 | SETUPSCRIPT="environment-setup-aarch64-pokysdk-linux" 12 | elif [ "$(uname -m)" = "x86_64" ]; then 13 | SETUPSCRIPT="environment-setup-x86_64-pokysdk-linux" 14 | fi 15 | 16 | # This entry point is so that we can do distro specific changes to the launch. 17 | if [ -e /opt/poky/${RELEASE}/${SETUPSCRIPT} ]; then 18 | # Buildtools has been installed so enable it 19 | . /opt/poky/${RELEASE}/${SETUPSCRIPT} || exit 1 20 | elif [ -e /opt/poky/${RELEASE}/${SETUPSCRIPT} ]; then 21 | # Buildtools(-make) has been installed so enable it 22 | . /opt/poky/${RELEASE}/${SETUPSCRIPT} || exit 1 23 | fi 24 | 25 | exec "$@" 26 | -------------------------------------------------------------------------------- /poky-entry.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # esdk-entry.py 4 | # 5 | # This script is to present arguments to the user of the container and then 6 | # chuck them over to the scripts that actually do the work. 7 | # 8 | # Copyright (C) 2016 Intel Corporation 9 | # 10 | # This program is free software; you can redistribute it and/or modify 11 | # it under the terms of the GNU General Public License version 2 as 12 | # published by the Free Software Foundation. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License along 20 | # with this program; if not, write to the Free Software Foundation, Inc., 21 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 22 | import argparse 23 | import os 24 | 25 | parser = argparse.ArgumentParser() 26 | parser.add_argument('--workdir', default='/home/pokyuser', 27 | help='The active directory once the container is running. ' 28 | 'In the abscence of the "id" argument, the uid and ' 29 | 'gid of the workdir will also be used for the user ' 30 | 'in the container.') 31 | 32 | parser.add_argument("--id", 33 | help='uid and gid to use for the user inside the ' 34 | 'container. It should be in the form uid:gid') 35 | 36 | parser.add_argument("cmd", nargs=argparse.REMAINDER, 37 | help='command to run after setting up container. ' 38 | 'Often used for testing.') 39 | 40 | args = parser.parse_args() 41 | 42 | if os.getcwd() != "/home/yoctouser": 43 | # --workdir was given to the docker command, not to us, so 44 | # we need to pretend it was given to us... 45 | args.workdir = os.getcwd() 46 | 47 | idargs = "" 48 | if args.id: 49 | uid, gid = args.id.split(":") 50 | idargs = "--uid={} --gid={}".format(uid, gid) 51 | 52 | elif args.workdir == '/home/pokyuser': 53 | # If the workdir wasn't specified pick a default uid and gid since 54 | # usersetup won't be able to calculate it from the non-existent workdir 55 | idargs = "--uid=1000 --gid=1000" 56 | 57 | cmd = """usersetup.py --username=pokyuser --workdir={wd} 58 | {idargs} poky-launch.sh {wd}""" \ 59 | .format(wd=args.workdir, idargs=idargs) 60 | cmd = cmd.split() 61 | if args.cmd: 62 | cmd.extend(args.cmd) 63 | os.execvp(cmd[0], cmd) 64 | -------------------------------------------------------------------------------- /poky-launch.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Copyright (C) 2016 Intel Corporation 3 | # 4 | # This program is free software; you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License version 2 as 6 | # published by the Free Software Foundation. 7 | # 8 | # This program is distributed in the hope that it will be useful, 9 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | # GNU General Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License along 14 | # with this program; if not, write to the Free Software Foundation, Inc., 15 | workdir=$1 16 | shift 17 | cd $workdir 18 | if [ $# -gt 0 ]; then 19 | exec "$@" 20 | else 21 | exec bash -i 22 | fi 23 | -------------------------------------------------------------------------------- /sudoers.usersetup: -------------------------------------------------------------------------------- 1 | usersetup ALL=NOPASSWD: /usr/bin/restrict_groupadd.sh 2 | usersetup ALL=NOPASSWD: /usr/bin/restrict_useradd.sh 3 | usersetup ALL = (pokyuser) NOPASSWD:SETENV: /usr/bin/poky-launch.sh 4 | Defaults:usersetup !secure_path 5 | -------------------------------------------------------------------------------- /tests/check-path.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # check-path.sh 4 | # 5 | # Copyright (C) 2019 Intel Corporation 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 2 as 9 | # published by the Free Software Foundation. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | 20 | # Make sure the path is preserved across sudo for usersetup. 21 | 22 | # usersetup only has permission to run certain commands without a password, so 23 | # create a script that does the "test" as /usr/bin/poky-launch.sh 24 | cat << EOF > /usr/bin/poky-launch.sh 25 | #!/bin/bash 26 | if ! echo "\$PATH" | grep -q -E ":bar:baz:cow$"; then 27 | echo \$PATH 28 | exit 1 29 | fi 30 | EOF 31 | 32 | useradd -m pokyuser 33 | 34 | sudo -E -u usersetup bash -c 'export PATH="$PATH":bar:baz:cow && /usr/bin/sudo -E -H -u pokyuser /usr/bin/poky-launch.sh' 35 | -------------------------------------------------------------------------------- /tests/check_args.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2019 Intel Corporation 2 | # 3 | # This program is free software; you can redistribute it and/or modify 4 | # it under the terms of the GNU General Public License version 2 as 5 | # published by the Free Software Foundation. 6 | # 7 | # This program is distributed in the hope that it will be useful, 8 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 9 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 10 | # GNU General Public License for more details. 11 | # 12 | # You should have received a copy of the GNU General Public License along 13 | # with this program; if not, write to the Free Software Foundation, Inc., 14 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 15 | 16 | import sys 17 | 18 | expected_args = [ '/workdir/check_args.py', 'arg1', 'second argument passed', 19 | 'third arg', 'arg4', 'this is the last argument' ] 20 | 21 | if expected_args != sys.argv: 22 | print("{} != {}".format(sys.argv, expected_args)) 23 | sys.exit(1) 24 | -------------------------------------------------------------------------------- /tests/distro-check.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # distro-check.sh 4 | # 5 | # Copyright (C) 2020 Intel Corporation 6 | # Copyright (C) 2024 Konsulko Group 7 | # 8 | # SPDX-License-Identifier: GPL-2.0-only 9 | # 10 | # Verify that the distro inside the container matches the one we expect based 11 | # on the build 12 | 13 | ENGINE_CMD=$1 14 | IMAGE=$2 15 | BASE_DISTRO="$3" 16 | 17 | declare -A distros 18 | 19 | distros["alma-8"]="AlmaLinux 8" 20 | distros["alma-9"]="AlmaLinux 9" 21 | distros["debian-10"]="Debian GNU/Linux 10 (buster)" 22 | distros["debian-11"]="Debian GNU/Linux 11 (bullseye)" 23 | distros["debian-12"]="Debian GNU/Linux 12 (bookworm)" 24 | distros["fedora-39"]="Fedora Linux 39 (Container Image)" 25 | distros["fedora-40"]="Fedora Linux 40 (Container Image)" 26 | distros["opensuse-15.4"]="openSUSE Leap 15.4" 27 | distros["opensuse-15.5"]="openSUSE Leap 15.5" 28 | distros["opensuse-15.6"]="openSUSE Leap 15.6" 29 | distros["ubuntu-18.04"]="Ubuntu 18.04" 30 | distros["ubuntu-20.04"]="Ubuntu 20.04" 31 | distros["ubuntu-22.04"]="Ubuntu 22.04" 32 | 33 | # If the distro is unknown it is a failure 34 | if [ "${distros[${BASE_DISTRO}]}" = "" ]; then 35 | echo "Unknown distro \"${BASE_DISTRO}\"" 36 | exit 1 37 | fi 38 | 39 | ${ENGINE_CMD} run --rm -t $IMAGE grep "${distros[${BASE_DISTRO}]}" /etc/os-release &> /dev/null 40 | RET=$? 41 | if [ $RET != 0 ]; then 42 | echo "Distro check failed. Outputting /etc/os-release:" 43 | ${ENGINE_CMD} run --rm -t $IMAGE cat /etc/os-release 44 | echo "" 45 | fi 46 | exit $RET 47 | -------------------------------------------------------------------------------- /tests/run-build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # run-build.sh 4 | # 5 | # Copyright (C) 2016 Intel Corporation 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 2 as 9 | # published by the Free Software Foundation. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | 20 | # do the build in the /workdir. Make it a temp directory as that 21 | # allows us to have a more stressful test 22 | BUILD_DIR=$(mktemp -d -p /workdir build_XXXXX) 23 | 24 | failure () { 25 | echo "$0 Failed" 26 | echo "Failed build located in ${BUILD_DIR}" 27 | exit -1 28 | } 29 | 30 | git clone --depth=1 git://git.yoctoproject.org/poky 31 | 32 | . ./poky/oe-init-build-env $BUILD_DIR 33 | 34 | bitbake quilt-native 35 | # did bitbake run happily? 36 | if [ $? -ne 0 ]; then 37 | failure 38 | fi 39 | # check some artifacts 40 | STATDIR=`find tmp/buildstats/ -iname quilt-native* -type d` 41 | for f in `ls $STATDIR`; do 42 | echo checking $f 43 | if ! grep PASSED $STATDIR/$f | egrep Status; then 44 | failure 45 | fi 46 | done 47 | # delete the build dir on success. 48 | rm $BUILD_DIR -rf 49 | -------------------------------------------------------------------------------- /tests/run-dumb-init-check.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # run-dumb-init-check.sh 4 | # 5 | # Copyright (C) 2016 Intel Corporation 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 2 as 9 | # published by the Free Software Foundation. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | 20 | # This verifies that dumb-init is running as the correct user and is running 21 | # what we expected. 22 | 23 | username="usersetup" 24 | username_width=${#username} 25 | expected='1 usersetup /usr/bin/dumb-init -- /usr/bin/poky-entry.py --workdir /workdir /workdir/run-dumb-init-check.sh' 26 | actual=`ps -w -w h -C dumb-init -o pid:1,user:$username_width,args` 27 | 28 | if [ "$expected" != "$actual" ]; then 29 | printf "expected dumb-init not found\n" 30 | printf "expected:\n%s\n" "$expected" 31 | printf "actual:\n%s\n" "$actual" 32 | printf "all:\n" 33 | ps -w -w -A -o pid,user:$username_width,args 34 | exit 1 35 | fi 36 | -------------------------------------------------------------------------------- /tests/run-workdir-check.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # run-workdir-check.sh 4 | # 5 | # Copyright (C) 2019 Intel Corporation 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 2 as 9 | # published by the Free Software Foundation. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | 20 | # This verifies that the workdir is what we expect it to be. 21 | 22 | if [ "$(pwd)" != "/workdir" ] ; then 23 | printf "expected workdir not found\n" 24 | printf "expected:\n%s\n" "/workdir" 25 | printf "actual:\n%s\n" "$(pwd)" 26 | exit 1 27 | fi 28 | -------------------------------------------------------------------------------- /tests/runtests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # runtests.sh 4 | # 5 | # Copyright (C) 2016 Intel Corporation 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 2 as 9 | # published by the Free Software Foundation. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License along 17 | # with this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 19 | # Allow the user to specify another command to use for building such as podman. 20 | if [ "${ENGINE_CMD}" = "" ]; then 21 | ENGINE_CMD="docker" 22 | fi 23 | 24 | IMAGE=$1 25 | 26 | for i in run-*.sh; do 27 | echo Running Test $i 28 | # make temporary workdir 29 | LOCAL_WDIR=$(mktemp -d wdir_XXXXX) 30 | # get absolute path to it 31 | LOCAL_WDIR=$(readlink -f ${LOCAL_WDIR}) 32 | cp $i $LOCAL_WDIR 33 | 34 | # This is to make sure the workdir is correct when using either docker 35 | # or the entrypoint workdir argument. 36 | if [ "$i" == "run-workdir-check.sh" ]; then 37 | # For passing the workdir to docker, use chmod to ensure that docker 38 | # will have permission to access the directory 39 | chmod o+x $LOCAL_WDIR 40 | ${ENGINE_CMD} run --rm -t -v $LOCAL_WDIR:/workdir \ 41 | --workdir /workdir \ 42 | $IMAGE \ 43 | /workdir/$i && 44 | ${ENGINE_CMD} run --rm -t -v $LOCAL_WDIR:/workdir \ 45 | $IMAGE \ 46 | --workdir /workdir \ 47 | /workdir/$i 48 | else 49 | ${ENGINE_CMD} run --rm -t -v $LOCAL_WDIR:/workdir \ 50 | $IMAGE \ 51 | --workdir /workdir \ 52 | /workdir/$i 53 | fi 54 | RET=$? 55 | if [ ${RET} != 0 ]; then 56 | echo "Test $i failed" 57 | echo "Workdir located in $LOCAL_WDIR" 58 | exit ${RET} 59 | fi 60 | rm $LOCAL_WDIR -rf 61 | done 62 | 63 | # Verify that each argument is preserved as expected 64 | echo Running Argument Test 65 | # make temporary workdir 66 | LOCAL_WDIR=$(mktemp -d wdir_XXXXX) 67 | # get absolute path to it 68 | LOCAL_WDIR=$(readlink -f ${LOCAL_WDIR}) 69 | cp check_args.py $LOCAL_WDIR 70 | 71 | ${ENGINE_CMD} run --rm -t -v $LOCAL_WDIR:/workdir \ 72 | $IMAGE \ 73 | --workdir /workdir \ 74 | python3 /workdir/check_args.py \ 75 | arg1 "second argument passed" "third arg" arg4 "this is the last argument" 76 | 77 | RET=$? 78 | if [ ${RET} != 0 ]; then 79 | echo "Test \"Argument Test\" failed" 80 | echo "Workdir located in $LOCAL_WDIR" 81 | exit ${RET} 82 | fi 83 | rm $LOCAL_WDIR -rf 84 | 85 | # Verify that the PATH is preserved 86 | echo Running PATH Test 87 | # make temporary workdir 88 | LOCAL_WDIR=$(mktemp -d wdir_XXXXX) 89 | # get absolute path to it 90 | LOCAL_WDIR=$(readlink -f ${LOCAL_WDIR}) 91 | cp check-path.sh $LOCAL_WDIR 92 | 93 | ${ENGINE_CMD} run --rm -t -v $LOCAL_WDIR:/workdir --user=root \ 94 | --entrypoint="/workdir/check-path.sh" \ 95 | $IMAGE 96 | 97 | RET=$? 98 | if [ ${RET} != 0 ]; then 99 | echo "Test \"PATH Test\" failed" 100 | echo "Workdir located in $LOCAL_WDIR" 101 | exit ${RET} 102 | fi 103 | rm $LOCAL_WDIR -rf 104 | 105 | 106 | echo Running Distro Check Test 107 | ./distro-check.sh ${ENGINE_CMD} ${IMAGE} ${BASE_DISTRO} 108 | RET=$? 109 | if [ ${RET} != 0 ]; then 110 | echo "Test \"Distro Check\" failed" 111 | exit ${RET} 112 | fi 113 | 114 | echo "All tests PASSED" 115 | --------------------------------------------------------------------------------