Clean the output log to remove ^M characters
[akaros.git] / tools / jenkins / launcher.sh
1 #!/bin/bash
2 # This script should be called from Jenkins when a new commit has been pushed 
3 # to the repo. 
4 # It analyzes what parts of the codebase have been modified, compiles everything
5 # that is needed, and reports on the results. 
6
7 set -e
8
9 readonly TMP_DIR=tmp
10 readonly DIFF_FILE=$TMP_DIR/changes.txt
11 readonly AKAROS_OUTPUT_FILE=$TMP_DIR/akaros_out.txt
12 readonly TEST_OUTPUT_DIR=output-tests
13 readonly TEST_DIR=tools/jenkins
14 readonly SCR_DIR=tools/jenkins/utils
15 readonly DOWNLOADS_DIR=dl
16
17 # Config files
18 readonly CONF_DIR=tools/jenkins/config
19 readonly CONF_COMP_COMPONENTS_FILE=$CONF_DIR/compilation_components.json
20
21 # Utility scripts
22 readonly SCR_WAIT_UNTIL=$SCR_DIR/wait_until.py
23 readonly SCR_GIT_CHANGES=$SCR_DIR/changes.py
24 readonly SCR_GEN_TEST_REPORTS=$SCR_DIR/test_reporter.py
25
26 # Busybox settings
27 readonly BUSYBOX_VERSION=1.17.3
28 readonly BUSYBOX_DL_URL=http://www.busybox.net/downloads/busybox-1.17.3.tar.bz2
29 readonly BUSYBOX_CONF_FILE=tools/patches/busybox/busybox-1.17.3-config
30
31 ################################################################################
32 ###############                 HELPER FUNCTIONS                 ###############
33 ################################################################################
34 function last_stable_build() {
35         curl -s localhost:8080/job/Test_akaros_github/lastStableBuild/api/json?tree=actions%5bbuildsByBranchName%5brevision%5bSHA1%5d%5d%5d | \
36                 python -c 'import sys, json; print json.load(sys.stdin)["actions"][3]["buildsByBranchName"]["'$GIT_BRANCH'"]["revision"]["SHA1"]'
37 }
38
39 ################################################################################
40 ###############                   INITIAL SETUP                  ###############
41 ################################################################################
42
43 if [ "$INITIAL_SETUP" == true ]; then
44         echo -e "\n[INITIAL_SETUP]: Begin"
45         # Create directory for tests and other temp files.
46         mkdir -p $TMP_DIR
47         mkdir -p $TEST_OUTPUT_DIR
48         mkdir -p $DOWNLOADS_DIR
49
50         # Compile QEMU launcher
51         mkdir -p $WORKSPACE/install/qemu_launcher/
52         gcc $SCR_DIR/qemu_launcher.c -o install/qemu_launcher/qemu_launcher
53
54         echo "* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *"
55         echo "Set up finished succesfully."
56         echo "Please run sudo chown root:root install/qemu_launcher/qemu_launcher"
57         echo "Please run sudo chmod 4755 install/qemu_launcher/qemu_launcher"
58         echo "* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *"
59         echo ""
60         echo -e "[INITIAL_SETUP]: End\n"
61         exit 0
62 fi
63
64
65
66 ################################################################################
67 ###############                 PRE BUILD SETUP                  ###############
68 ################################################################################
69
70 function add_cross_compiler_to_path() {
71         export PATH=$WORKSPACE/install/riscv-ros-gcc/bin:$PATH
72         export PATH=$WORKSPACE/install/i686-ros-gcc/bin:$PATH
73         export PATH=$WORKSPACE/install/x86_64-ros-gcc/bin:$PATH
74 }
75
76 # Clean these two directories
77 rm $TMP_DIR/* $TEST_OUTPUT_DIR/* -f
78 add_cross_compiler_to_path
79
80
81 ################################################################################
82 ###############                    COMPILATION                   ###############
83 ################################################################################
84
85 function build_config() {
86         echo -e "\n[SET_MAKE_CONFIG]: Begin"
87
88         # Begin with default configuration.
89         case "$COMPILATION_ARCH" in
90         RISCV)  make ARCH=riscv defconfig
91             ;;
92         I686)  make ARCH=x86 defconfig
93                    sed -i -e 's/CONFIG_64BIT=y/# CONFIG_64BIT is not set/' \
94                           -e 's/# CONFIG_X86_32 is not set/CONFIG_X86_32=y/' \
95                           -e 's/CONFIG_X86_64=y/# CONFIG_X86_64 is not set/' \
96                           .config
97             ;;
98         X86_64)  make ARCH=x86 defconfig
99             ;;
100         esac
101
102         # Enable tests to run.
103         # These don't take much to execute so we can run them always and just parse
104         # results if needed.
105         echo "CONFIG_KERNEL_POSTBOOT_TESTING=y" >> .config
106         echo "CONFIG_USERSPACE_TESTING=y" >> .config
107         # Set all config variables dependent on the above changes to their defaults
108         # without prompting
109         make olddefconfig 
110
111         echo -e "[SET_MAKE_CONFIG]: End\n"
112 }
113
114 function build_cross_compiler() {
115         declare -A ARCH_SUBDIRS=( ["RISCV"]="riscv-ros-gcc" \
116                                   ["I686"]="i686-ros-gcc" \
117                                   ["X86_64"]="x86_64-ros-gcc" )
118
119         echo -e "\n[BUILD_CROSS_COMPILER]: Begin"
120
121         cd tools/compilers/gcc-glibc
122
123         # Clean everything up
124         # TODO: Possibly down the line try to optimize this to only clean the 
125         # architecture that we need to rebuild.
126         make clean
127
128         # Define cross compiler Makelocal.
129         echo "# Number of make jobs to spawn.  
130 MAKE_JOBS := 3
131 RISCV_INSTDIR         := $WORKSPACE/install/${ARCH_SUBDIRS["RISCV"]}/
132 I686_INSTDIR          := $WORKSPACE/install/${ARCH_SUBDIRS["I686"]}/
133 X86_64_INSTDIR        := $WORKSPACE/install/${ARCH_SUBDIRS["X86_64"]}/
134 " > Makelocal
135
136         # Create / clean directory where the cross compiler will be installed.
137         CROSS_COMP_DIR=$WORKSPACE/install/${ARCH_SUBDIRS["$COMPILATION_ARCH"]}/
138         mkdir -p CROSS_COMP_DIR
139         rm -rf CROSS_COMP_DIR*
140
141         # Compile cross compiler.
142         case "$COMPILATION_ARCH" in
143         RISCV)  make riscv
144             ;;
145         I686)  make i686
146             ;;
147         X86_64)  make x86_64
148             ;;
149         esac
150
151         # Go back to root directory.
152         cd ../../..
153         echo -e "[BUILD_CROSS_COMPILER]: End\n"
154 }
155
156 function build_kernel() {
157         echo -e "\n[BUILD_KERNEL]: Begin"
158         make clean
159         make
160         echo -e "[BUILD_KERNEL]: End\n"
161 }
162
163 function build_userspace() {
164         echo -e "\n[BUILD_USERSPACE]: Begin"
165         # This is needed because of a bug that won't let tests to be compiled
166         # unless the following files are present.
167         cd kern/kfs/bin
168         touch busybox
169         touch chmod
170         cd -
171
172         # Build and install user libs.
173         make userclean
174         make install-libs
175
176         # Compile tests.
177         make utest
178
179         # Fill memory with tests.
180         make fill-kfs
181
182         # Recompile kernel.
183         make
184         echo -e "[BUILD_USERSPACE]: End\n"
185 }
186
187 function build_busybox() {
188         echo -e "\n[BUILD_BUSYBOX]: Begin"
189         
190         BUSYBOX_DIR=busybox-$BUSYBOX_VERSION
191         
192         cd $DOWNLOADS_DIR
193         
194         # Download busybox if we do not have it yet.
195         if [[ ! -d "$BUSYBOX_DIR" ]]; then
196                 echo "Trying to download from $BUSYBOX_DL_URL ..."
197                 
198                 wget $BUSYBOX_DL_URL -O busybox-$BUSYBOX_VERSION.tar.bz2
199                 tar -jxvf busybox-$BUSYBOX_VERSION.tar.bz2
200                 rm busybox-$BUSYBOX_VERSION.tar.bz2
201                 cp ../$BUSYBOX_CONF_FILE $BUSYBOX_DIR/.config
202         fi
203
204         # Build busybox and copy it into kfs
205         echo -e "Build busybox"
206         cd $BUSYBOX_DIR
207         make
208         cp busybox_unstripped ../../kern/kfs/bin/busybox
209         cd ../../
210
211         # Recompile kernel to include busybox
212         echo -e "Recompile kernel to include busybox"
213         make
214
215         echo -e "[BUILD_BUSYBOX]: End\n"
216 }
217
218 # TODO: This won't work for RISCV, it must be changed to whatever is used.
219 function run_qemu() {
220         echo -e "\n[RUN_AKAROS_IN_QEMU]: Begin"
221
222         echo "-include $CONF_DIR/Makelocal_qemu" > Makelocal
223         export PATH=$WORKSPACE/install/qemu_launcher/:$PATH
224         make qemu > $AKAROS_OUTPUT_FILE &
225         MAKE_PID=$!
226
227         WAIT_RESULT=`$SCR_WAIT_UNTIL $AKAROS_OUTPUT_FILE END_USERSPACE_TESTS \
228             ${MAX_RUN_TIME:-100}`
229
230         # Extract Qemu_launcher PID
231         QEMU_PID=`ps --ppid $MAKE_PID | grep qemu_launcher | sed -e 's/^\s*//' | \
232                   cut -d' ' -f1`
233
234         # To kill qemu we need to send a USR1 signal to Qemu_launcher.
235         kill -10 $QEMU_PID
236
237         # Then we wait....
238         wait $MAKE_PID
239
240         # clean and cat the output of the file so we can see it in the console log
241         sed -i -e 's/\r//g' $AKAROS_OUTPUT_FILE
242         cat $AKAROS_OUTPUT_FILE
243
244         echo -e "[RUN_AKAROS_IN_QEMU]: End\n"
245
246         # If the run was terminated via a timeout, then we finish with an error.
247         if [[ "$WAIT_RESULT" == TIMEOUT ]]; then
248                 echo "AKAROS was terminated after running for $MAX_RUN_TIME seconds."
249                 exit 1
250         fi
251 }
252
253
254
255 if [ "$COMPILE_ALL" == true ]; then
256         echo "Building all AKAROS"
257         build_config
258         
259         build_cross_compiler
260         build_kernel
261         build_userspace
262         build_busybox
263
264         run_qemu
265
266         AFFECTED_COMPONENTS="cross-compiler kernel userspace busybox"
267 else
268         # Save changed files between last tested commit and current one.
269         git diff --stat $(last_stable_build) $GIT_COMMIT > $DIFF_FILE
270
271         # Extract build targets by parsing diff file.
272         AFFECTED_COMPONENTS=`$SCR_GIT_CHANGES $DIFF_FILE $CONF_COMP_COMPONENTS_FILE`
273         # Can contain {cross-compiler, kernel, userspace, busybox}
274
275         if [[ -n $AFFECTED_COMPONENTS ]]; 
276         then
277                 echo "Detected changes in "$AFFECTED_COMPONENTS
278                 build_config
279
280                 if [[ $AFFECTED_COMPONENTS == *cross-compiler* ]]
281                 then
282                         build_cross_compiler
283                         build_kernel
284                         build_userspace
285                         build_busybox
286                 else 
287                         if [[ $AFFECTED_COMPONENTS == *kernel* ]]
288                         then
289                                 build_kernel
290                         fi
291
292                         if [[ $AFFECTED_COMPONENTS == *userspace* ]]
293                         then
294                                 build_userspace
295                         fi
296
297                         if [[ $AFFECTED_COMPONENTS == *busybox* ]]
298                         then
299                                 build_busybox
300                         fi
301                 fi
302         else
303                 echo "Skipping build. No changes detected."
304         fi
305
306         run_qemu
307 fi
308
309
310 ################################################################################
311 ###############                  TEST REPORTING                  ###############
312 ################################################################################
313
314 echo -e "\n[TEST_REPORTING]: Begin"
315
316 # Generate test report
317 $SCR_GEN_TEST_REPORTS $AKAROS_OUTPUT_FILE $TEST_OUTPUT_DIR 
318 echo "Tests generated in $TEST_OUTPUT_DIR"
319
320 echo -e "[TEST_REPORTING]: End\n"