Jenkins: Enable the lousy lapic timer since we don't have KVM
[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/$JOB_NAME/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                           -e 's/CONFIG_LOUSY_LAPIC_TIMER=y/# CONFIG_LOUSY_LAPIC_TIMER is not set/' \
97                           .config
98             ;;
99         X86_64)  make ARCH=x86 defconfig
100             ;;
101         esac
102
103         # Enable tests to run.
104         # These don't take much to execute so we can run them always and just parse
105         # results if needed.
106         echo "CONFIG_KERNEL_TESTING=y" >> .config
107         echo "CONFIG_USERSPACE_TESTING=y" >> .config
108         # Set all config variables dependent on the above changes to their defaults
109         # without prompting
110         make olddefconfig 
111
112         echo -e "[SET_MAKE_CONFIG]: End\n"
113 }
114
115 function build_cross_compiler() {
116         declare -A ARCH_SUBDIRS=( ["RISCV"]="riscv-ros-gcc" \
117                                   ["I686"]="i686-ros-gcc" \
118                                   ["X86_64"]="x86_64-ros-gcc" )
119
120         echo -e "\n[BUILD_CROSS_COMPILER]: Begin"
121
122         cd tools/compilers/gcc-glibc
123
124         # Clean everything up
125         # TODO: Possibly down the line try to optimize this to only clean the 
126         # architecture that we need to rebuild.
127         make clean
128
129         # Define cross compiler Makelocal.
130         echo "# Number of make jobs to spawn.  
131 MAKE_JOBS := 3
132 RISCV_INSTDIR         := $WORKSPACE/install/${ARCH_SUBDIRS["RISCV"]}/
133 I686_INSTDIR          := $WORKSPACE/install/${ARCH_SUBDIRS["I686"]}/
134 X86_64_INSTDIR        := $WORKSPACE/install/${ARCH_SUBDIRS["X86_64"]}/
135 " > Makelocal
136
137         # Create / clean directory where the cross compiler will be installed.
138         CROSS_COMP_DIR=$WORKSPACE/install/${ARCH_SUBDIRS["$COMPILATION_ARCH"]}/
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         echo -e "[BUILD_USERSPACE]: End\n"
183 }
184
185 function build_busybox() {
186         echo -e "\n[BUILD_BUSYBOX]: Begin"
187         
188         BUSYBOX_DIR=busybox-$BUSYBOX_VERSION
189         
190         cd $DOWNLOADS_DIR
191         
192         # Download busybox if we do not have it yet.
193         if [[ ! -d "$BUSYBOX_DIR" ]]; then
194                 echo "Trying to download from $BUSYBOX_DL_URL ..."
195                 
196                 wget $BUSYBOX_DL_URL -O busybox-$BUSYBOX_VERSION.tar.bz2
197                 tar -jxvf busybox-$BUSYBOX_VERSION.tar.bz2
198                 rm busybox-$BUSYBOX_VERSION.tar.bz2
199                 cp ../$BUSYBOX_CONF_FILE $BUSYBOX_DIR/.config
200         fi
201
202         # Build busybox and copy it into kfs
203         echo -e "Build busybox"
204         cd $BUSYBOX_DIR
205         make
206         cp busybox_unstripped ../../kern/kfs/bin/busybox
207         cd ../../
208
209         echo -e "[BUILD_BUSYBOX]: End\n"
210 }
211
212 function build_all() {
213         build_config
214         build_cross_compiler
215         build_userspace
216         build_busybox
217         build_kernel
218 }
219
220 # TODO: This won't work for RISCV, it must be changed to whatever is used.
221 function run_qemu() {
222         echo -e "\n[RUN_AKAROS_IN_QEMU]: Begin"
223
224         echo "-include $CONF_DIR/Makelocal_qemu" > Makelocal
225         export PATH=$WORKSPACE/install/qemu_launcher/:$PATH
226         make qemu > $AKAROS_OUTPUT_FILE &
227         MAKE_PID=$!
228
229         WAIT_RESULT=`$SCR_WAIT_UNTIL $AKAROS_OUTPUT_FILE END_USERSPACE_TESTS \
230             ${MAX_RUN_TIME:-100}`
231
232         # Extract Qemu_launcher PID
233         QEMU_PID=`ps --ppid $MAKE_PID | grep qemu_launcher | sed -e 's/^\s*//' | \
234                   cut -d' ' -f1`
235
236         # To kill qemu we need to send a USR1 signal to Qemu_launcher.
237         kill -10 $QEMU_PID
238
239         # Then we wait....
240         wait $MAKE_PID
241
242         # clean and cat the output of the file so we can see it in the console log
243         sed -i -e 's/\r//g' $AKAROS_OUTPUT_FILE
244         cat $AKAROS_OUTPUT_FILE
245
246         echo -e "[RUN_AKAROS_IN_QEMU]: End\n"
247
248         # If the run was terminated via a timeout, then we finish with an error.
249         if [[ "$WAIT_RESULT" == TIMEOUT ]]; then
250                 echo "AKAROS was terminated after running for $MAX_RUN_TIME seconds."
251                 exit 1
252         fi
253 }
254
255
256
257 if [ "$COMPILE_ALL" == true ]; then
258         echo "Building all AKAROS"
259         build_all
260         run_qemu
261
262         AFFECTED_COMPONENTS="cross-compiler kernel userspace busybox"
263 else
264         # Save changed files between last tested commit and current one.
265         git diff --stat $(last_stable_build) $GIT_COMMIT > $DIFF_FILE
266         if [ $? -ne 0 ]; then
267                 echo "Diff failed, rebuild everything"
268                 build_all
269                 run_qemu
270
271                 AFFECTED_COMPONENTS="cross-compiler kernel userspace busybox"
272         else 
273                 # Extract build targets by parsing diff file.
274                 AFFECTED_COMPONENTS=`$SCR_GIT_CHANGES $DIFF_FILE $CONF_COMP_COMPONENTS_FILE`
275                 # Can contain {cross-compiler, kernel, userspace, busybox}
276
277                 if [[ -n $AFFECTED_COMPONENTS ]]; 
278                 then
279                         echo "Detected changes in "$AFFECTED_COMPONENTS
280                         build_config
281
282                         if [[ $AFFECTED_COMPONENTS == *cross-compiler* ]]
283                         then
284                                 build_cross_compiler
285                                 build_userspace
286                                 build_busybox
287                                 build_kernel
288                         else 
289                                 if [[ $AFFECTED_COMPONENTS == *userspace* ]]
290                                 then
291                                         build_userspace
292                                 fi
293
294                                 if [[ $AFFECTED_COMPONENTS == *busybox* ]]
295                                 then
296                                         build_busybox
297                                 fi
298
299                                 if [[ $AFFECTED_COMPONENTS == *kernel* ]]
300                                 then
301                                         build_kernel
302                                 fi
303                         fi
304                 else
305                         echo "Skipping build. No changes detected."
306                 fi
307
308                 run_qemu
309         fi
310 fi
311
312
313 ################################################################################
314 ###############                  TEST REPORTING                  ###############
315 ################################################################################
316
317 echo -e "\n[TEST_REPORTING]: Begin"
318
319 # Generate test report
320 $SCR_GEN_TEST_REPORTS $AKAROS_OUTPUT_FILE $TEST_OUTPUT_DIR 
321 echo "Tests generated in $TEST_OUTPUT_DIR"
322
323 echo -e "[TEST_REPORTING]: End\n"