mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-22 21:23:07 +03:00
e226251b27
Use code style defined in Arduino project to check code style of the examples. The check is done by formatting all files with astyle and checking whether any changes have been introduced.
269 lines
8.0 KiB
Bash
Executable File
269 lines
8.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
function print_size_info()
|
|
{
|
|
elf_file=$1
|
|
|
|
if [ -z "$elf_file" ]; then
|
|
printf "sketch data rodata bss text irom0.text dram flash\n"
|
|
return 0
|
|
fi
|
|
|
|
elf_name=$(basename $elf_file)
|
|
sketch_name="${elf_name%.*}"
|
|
# echo $sketch_name
|
|
declare -A segments
|
|
while read -a tokens; do
|
|
seg=${tokens[0]}
|
|
seg=${seg//./}
|
|
size=${tokens[1]}
|
|
addr=${tokens[2]}
|
|
if [ "$addr" -eq "$addr" -a "$addr" -ne "0" ] 2>/dev/null; then
|
|
segments[$seg]=$size
|
|
fi
|
|
|
|
|
|
done < <(xtensa-lx106-elf-size --format=sysv $elf_file)
|
|
|
|
total_ram=$((${segments[data]} + ${segments[rodata]} + ${segments[bss]}))
|
|
total_flash=$((${segments[data]} + ${segments[rodata]} + ${segments[text]} + ${segments[irom0text]}))
|
|
|
|
printf "%-28s %-8d %-8d %-8d %-8d %-8d %-8d %-8d\n" $sketch_name ${segments[data]} ${segments[rodata]} ${segments[bss]} ${segments[text]} ${segments[irom0text]} $total_ram $total_flash
|
|
return 0
|
|
}
|
|
|
|
function build_sketches()
|
|
{
|
|
set +e
|
|
local arduino=$1
|
|
local srcpath=$2
|
|
local build_arg=$3
|
|
local build_dir=build.tmp
|
|
mkdir -p $build_dir
|
|
local build_cmd="python tools/build.py -b generic -v -w all -k -p $PWD/$build_dir $build_arg "
|
|
local sketches=$(find $srcpath -name *.ino)
|
|
print_size_info >size.log
|
|
export ARDUINO_IDE_PATH=$arduino
|
|
for sketch in $sketches; do
|
|
rm -rf $build_dir/*
|
|
local sketchdir=$(dirname $sketch)
|
|
local sketchdirname=$(basename $sketchdir)
|
|
local sketchname=$(basename $sketch)
|
|
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
echo "Skipping $sketch, because it is not the main sketch file";
|
|
continue
|
|
fi;
|
|
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
echo -e "\n ------------ Skipping $sketch ------------ \n";
|
|
continue
|
|
fi
|
|
echo -e "\n ------------ Building $sketch ------------ \n";
|
|
# $arduino --verify $sketch;
|
|
echo "$build_cmd $sketch"
|
|
time ($build_cmd $sketch >build.log)
|
|
local result=$?
|
|
if [ $result -ne 0 ]; then
|
|
echo "Build failed ($1)"
|
|
echo "Build log:"
|
|
cat build.log
|
|
set -e
|
|
return $result
|
|
else
|
|
local warns=$( grep -c warning: build.log )
|
|
if [ $warns -ne 0 ]; then
|
|
echo "Warnings detected, log follows:"
|
|
cat build.log
|
|
fi
|
|
fi
|
|
rm build.log
|
|
print_size_info $build_dir/*.elf >>size.log
|
|
done
|
|
set -e
|
|
}
|
|
|
|
function install_libraries()
|
|
{
|
|
mkdir -p $HOME/Arduino/libraries
|
|
pushd $HOME/Arduino/libraries
|
|
|
|
# install ArduinoJson library
|
|
wget https://github.com/bblanchon/ArduinoJson/releases/download/v4.6.1/ArduinoJson-v4.6.1.zip && unzip ArduinoJson-v4.6.1.zip
|
|
|
|
popd
|
|
}
|
|
|
|
function install_ide()
|
|
{
|
|
local ide_path=$1
|
|
local core_path=$2
|
|
wget -O arduino.tar.xz https://www.arduino.cc/download.php?f=/arduino-nightly-linux64.tar.xz
|
|
tar xf arduino.tar.xz
|
|
mv arduino-nightly $ide_path
|
|
cd $ide_path/hardware
|
|
mkdir esp8266com
|
|
cd esp8266com
|
|
ln -s $core_path esp8266
|
|
# Set custom warnings for all builds (i.e. could add -Wextra at some point)
|
|
echo "compiler.c.extra_flags=-Wall -Werror" > esp8266/platform.local.txt
|
|
echo "compiler.cpp.extra_flags=-Wall -Werror" >> esp8266/platform.local.txt
|
|
cd esp8266/tools
|
|
python get.py
|
|
export PATH="$ide_path:$core_path/tools/xtensa-lx106-elf/bin:$PATH"
|
|
}
|
|
|
|
function build_docs()
|
|
{
|
|
SPHINXOPTS="-W" make html
|
|
}
|
|
|
|
function run_host_tests()
|
|
{
|
|
pushd host
|
|
make
|
|
make clean-objects
|
|
popd
|
|
}
|
|
|
|
function build_package()
|
|
{
|
|
export PKG_URL=https://github.com/esp8266/Arduino/releases/download/$TRAVIS_TAG/esp8266-$TRAVIS_TAG.zip
|
|
export DOC_URL=https://arduino-esp8266.readthedocs.io/en/$TRAVIS_TAG/
|
|
./build_boards_manager_package.sh
|
|
}
|
|
|
|
function build_boards()
|
|
{
|
|
echo -e "travis_fold:start:build_boards"
|
|
tools/boards.txt.py --boardsgen --ldgen --packagegen --docgen
|
|
git diff --exit-code -- boards.txt \
|
|
package/package_esp8266com_index.template.json \
|
|
doc/boards.rst \
|
|
tools/sdk/ld/
|
|
echo -e "travis_fold:end:build_boards"
|
|
}
|
|
|
|
function install_platformio()
|
|
{
|
|
pip install --user -U https://github.com/platformio/platformio/archive/develop.zip
|
|
platformio platform install https://github.com/platformio/platform-espressif8266.git#feature/stage
|
|
sed -i 's/https:\/\/github\.com\/esp8266\/Arduino\.git/*/' ~/.platformio/platforms/espressif8266/platform.json
|
|
ln -s $TRAVIS_BUILD_DIR ~/.platformio/packages/framework-arduinoespressif8266
|
|
# Install dependencies:
|
|
# - esp8266/examples/ConfigFile
|
|
pio lib install ArduinoJson
|
|
}
|
|
|
|
function build_sketches_with_platformio()
|
|
{
|
|
set +e
|
|
local srcpath=$1
|
|
local build_arg=$2
|
|
local sketches=$(find $srcpath -name *.ino)
|
|
for sketch in $sketches; do
|
|
local sketchdir=$(dirname $sketch)
|
|
local sketchdirname=$(basename $sketchdir)
|
|
local sketchname=$(basename $sketch)
|
|
if [[ "${sketchdirname}.ino" != "$sketchname" ]]; then
|
|
echo "Skipping $sketch, beacause it is not the main sketch file";
|
|
continue
|
|
fi;
|
|
if [[ -f "$sketchdir/.test.skip" ]]; then
|
|
echo -e "\n ------------ Skipping $sketch ------------ \n";
|
|
continue
|
|
fi
|
|
local build_cmd="pio ci $sketchdir $build_arg"
|
|
echo -e "\n ------------ Building $sketch ------------ \n";
|
|
echo "$build_cmd"
|
|
time ($build_cmd >build.log)
|
|
local result=$?
|
|
if [ $result -ne 0 ]; then
|
|
echo "Build failed ($1)"
|
|
echo "Build log:"
|
|
cat build.log
|
|
set -e
|
|
return $result
|
|
fi
|
|
rm build.log
|
|
done
|
|
set -e
|
|
}
|
|
|
|
function install_arduino()
|
|
{
|
|
# Install Arduino IDE and required libraries
|
|
echo -e "travis_fold:start:sketch_test_env_prepare"
|
|
cd $TRAVIS_BUILD_DIR
|
|
install_ide $HOME/arduino_ide $TRAVIS_BUILD_DIR
|
|
which arduino
|
|
cd $TRAVIS_BUILD_DIR
|
|
install_libraries
|
|
echo -e "travis_fold:end:sketch_test_env_prepare"
|
|
}
|
|
|
|
function build_sketches_with_arduino()
|
|
{
|
|
# Compile sketches
|
|
echo -e "travis_fold:start:sketch_test"
|
|
build_sketches $HOME/arduino_ide $TRAVIS_BUILD_DIR/libraries "-l $HOME/Arduino/libraries"
|
|
echo -e "travis_fold:end:sketch_test"
|
|
|
|
# Generate size report
|
|
echo -e "travis_fold:start:size_report"
|
|
cat size.log
|
|
echo -e "travis_fold:end:size_report"
|
|
}
|
|
|
|
function check_examples_style()
|
|
{
|
|
echo -e "travis_fold:start:check_examples_style"
|
|
|
|
find $TRAVIS_BUILD_DIR/libraries -name '*.ino' -exec \
|
|
astyle \
|
|
--suffix=none \
|
|
--options=$TRAVIS_BUILD_DIR/tests/examples_style.conf {} \;
|
|
|
|
git diff --exit-code -- $TRAVIS_BUILD_DIR/libraries
|
|
|
|
echo -e "travis_fold:end:check_examples_style"
|
|
}
|
|
|
|
set -e
|
|
|
|
if [ -z "$TRAVIS_BUILD_DIR" ]; then
|
|
echo "TRAVIS_BUILD_DIR is not set, trying to guess:"
|
|
pushd $(dirname $0)/../ > /dev/null
|
|
TRAVIS_BUILD_DIR=$PWD
|
|
popd > /dev/null
|
|
echo "TRAVIS_BUILD_DIR=$TRAVIS_BUILD_DIR"
|
|
fi
|
|
|
|
if [ "$BUILD_TYPE" = "build" ]; then
|
|
install_arduino
|
|
build_sketches_with_arduino
|
|
elif [ "$BUILD_TYPE" = "platformio" ]; then
|
|
# PlatformIO
|
|
install_platformio
|
|
build_sketches_with_platformio $TRAVIS_BUILD_DIR/libraries "--board nodemcuv2 --verbose"
|
|
elif [ "$BUILD_TYPE" = "docs" ]; then
|
|
# Build documentation using Sphinx
|
|
cd $TRAVIS_BUILD_DIR/doc
|
|
build_docs
|
|
elif [ "$BUILD_TYPE" = "package" ]; then
|
|
# Check that boards.txt, ld scripts, package JSON template, and boards.rst are up to date
|
|
build_boards
|
|
# Build release package
|
|
cd $TRAVIS_BUILD_DIR/package
|
|
build_package
|
|
elif [ "$BUILD_TYPE" = "host_tests" ]; then
|
|
# Run host side tests
|
|
cd $TRAVIS_BUILD_DIR/tests
|
|
run_host_tests
|
|
elif [ "$BUILD_TYPE" = "style_check" ]; then
|
|
# Check code style
|
|
check_examples_style
|
|
else
|
|
echo "BUILD_TYPE not set"
|
|
exit 1
|
|
fi
|
|
|