OrgZephyr/mcuboot
OrgZephyr
/
mcuboot
mirror of https://github.com/zephyrproject-rtos/mcuboot.git
1
0
Fork 0
Code Issues Releases Wiki Activity
mcuboot/docs/testplan-zephyr.md

72 lines
1.9 KiB
Markdown
Raw Normal View History

doc: Fix case in titles Unified case in titles. Fixed small grammar issues. Signed-off-by: Francesco Servidio <francesco.servidio@nordicsemi.no>
2021-11-03 20:19:22 +08:00
# Zephyr test plan
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
doc: Fixed consistency of MCUboot Fixed the consistency of the case used in the term MCUboot. Signed-off-by: Francesco Servidio <francesco.servidio@nordicsemi.no>
2021-10-20 21:27:16 +08:00
The following roughly describes how MCUboot is tested on Zephyr. The
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
testing is done with the code in `samples/zephyr`. These examples
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
were written using the FRDM-K64F, but other boards should be similar.
At this time, however, the partitions are hardcoded in the Makefile
targets to flash.
zephyr: add script for running mcuboot tests It's onerous to work through the tests in docs/testplan-zephyr.md by hand. Add a script which takes the thinking out of it. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com>
2017-11-15 09:22:03 +08:00
Note that the script "run-tests.sh" in that directory is helpful for
automating the process, and provides simple "y or n" prompts for each
test case and expected result.
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
## Building and running.
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
The tests are build using the various `test-*` targets in
`samples/zephyr/Makefile`. For each test, invoke `make` with that
target:
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
$ make test-good-rsa
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
Begin by doing a full erase, and programming the bootloader itself:
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
docs: samples: Update pyocd calls to unified tool subcommands pyocd 0.14.0 merged its command-line tools into a unified pyocd tool with subcommands. The separate command-line tools still remain, but are deprecated. Update all pyocd calls in samples and documentation to use the new unified pyocd tool with subcommands. Note that pyocd 0.15.0 has an issue with the command 'pyocd erase', which was fixed in pyocd 0.16.0. Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-02-19 07:20:00 +08:00
$ pyocd erase --chip
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
$ make flash_boot
After it resets, look for "main: Starting bootloader", a few debug
messages, and lastly: "main: Unable to find bootable image".
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
Then, load hello1:
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
$ make flash_hello1
This should print "main: Jumping to the first image slot", and you
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
should get an image "hello1".
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
Note that there are comments with each test target describing the
intended behavior for each of these steps. Sometimes an upgrade will
happen and sometimes it will not.
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
$ make flash_hello2
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
This should print a message: `boot_swap_type: Swap type: test`, and
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
you should see "hello2".
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
Now reset the target::
docs: samples: Update pyocd calls to unified tool subcommands pyocd 0.14.0 merged its command-line tools into a unified pyocd tool with subcommands. The separate command-line tools still remain, but are deprecated. Update all pyocd calls in samples and documentation to use the new unified pyocd tool with subcommands. Note that pyocd 0.15.0 has an issue with the command 'pyocd erase', which was fixed in pyocd 0.16.0. Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-02-19 07:20:00 +08:00
$ pyocd commander -c reset
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
And you should see a revert and "hello1" running.
## Testing that mark ok works
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
Repeat this, to make sure we can mark the image as OK, and that a
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
revert doesn't happen:
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
$ make flash_hello1
$ make flash_hello2
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
We should have just booted the hello2. Mark this as OK:
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
docs: samples: Update pyocd calls to unified tool subcommands pyocd 0.14.0 merged its command-line tools into a unified pyocd tool with subcommands. The separate command-line tools still remain, but are deprecated. Update all pyocd calls in samples and documentation to use the new unified pyocd tool with subcommands. Note that pyocd 0.15.0 has an issue with the command 'pyocd erase', which was fixed in pyocd 0.16.0. Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-02-19 07:20:00 +08:00
$ pyocd flash -a 0x7ffe8 image_ok.bin
$ pyocd commander -c reset
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
And make sure this stays in the "hello2" image.
Zephyr: Document testplan This document describes the manual testing done on Zephyr. It uses a bunch of git patches to make modifications to the code, where each is then tried and then backed out. Signed-off-by: David Brown <david.brown@linaro.org>
2017-07-28 00:40:42 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
This step doesn't make sense on the tests where the upgrade doesn't
happen.
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
## Testing all configurations
Make docs more visible from home page Add links to the other documents to the homepage at `index.md`. Clean up some of these other documents (including converting the Zephyr test plan to markdown). Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-12 04:47:48 +08:00
zephyr: Move testplan into sample Makefile Instead of a bunch of patches that tend to become conflicting, use the newly parameterized Makefile to make all of the test plans into make targets. Update the instructions to match this. Signed-off-by: David Brown <david.brown@linaro.org>
2017-09-15 05:10:24 +08:00
Repeat these steps for each of the `test-*` targest in the Makefile.