tests/test-init.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; ======================================================================
   3 ;;;; File:    test-init.lisp
   4 ;;;; Authors: Marcus Pearce <m.t.pearce@city.ac.uk>, Kevin Rosenberg
   5 ;;;; Created: 30/03/2004
   6 ;;;; Updated: $Id$
   7 ;;;;
   8 ;;;; Initialisation utilities for running regression tests on CLSQL.
   9 ;;;;
  10 ;;;; This file is part of CLSQL.
  11 ;;;;
  12 ;;;; CLSQL users are granted the rights to distribute and use this software
  13 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  14 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  15 ;;;; ======================================================================
  16
  17 (in-package #:clsql-tests)
  18
  19 (defvar *report-stream* *standard-output* "Stream to send text report.")
  20 (defvar *sexp-report-stream* nil "Stream to send sexp report.")
  21 (defvar *rt-connection*)
  22 (defvar *rt-fddl*)
  23 (defvar *rt-fdml*)
  24 (defvar *rt-ooddl*)
  25 (defvar *rt-oodml*)
  26 (defvar *rt-syntax*)
  27 (defvar *rt-time*)
  28
  29 (defvar *test-database-type* nil)
  30 (defvar *test-database-underlying-type* nil)
  31 (defvar *test-database-user* nil)
  32
  33 (defclass thing ()
  34   ((extraterrestrial :initform nil :initarg :extraterrestrial)))
  35
  36 (def-view-class person (thing)
  37   ((height :db-kind :base :accessor height :type float
  38            :initarg :height)
  39    (married :db-kind :base :accessor married :type boolean
  40             :initarg :married)
  41    (birthday :type clsql:wall-time :initarg :birthday)
  42    (hobby :db-kind :virtual :initarg :hobby :initform nil)))
  43
  44 (def-view-class employee (person)
  45   ((emplid
  46     :db-kind :key
  47     :db-constraints :not-null
  48     :type integer
  49     :initarg :emplid)
  50    (groupid
  51     :db-kind :key
  52     :db-constraints :not-null
  53     :type integer
  54     :initarg :groupid)
  55    (first-name
  56     :accessor first-name
  57     :type (string 30)
  58     :initarg :first-name)
  59    (last-name
  60     :accessor last-name
  61     :type (string 30)
  62     :initarg :last-name)
  63    (email
  64     :accessor employee-email
  65     :type (string 100)
  66     :initarg :email)
  67    (ecompanyid
  68     :type integer
  69     :initarg :companyid)
  70    (company
  71     :accessor employee-company
  72     :db-kind :join
  73     :db-info (:join-class company
  74                           :home-key ecompanyid
  75                           :foreign-key companyid
  76                           :set nil))
  77    (managerid
  78     :type integer
  79     :initarg :managerid)
  80    (manager
  81     :accessor employee-manager
  82     :db-kind :join
  83     :db-info (:join-class employee
  84                           :home-key managerid
  85                           :foreign-key emplid
  86                           :set nil))
  87    (addresses
  88     :accessor employee-addresses
  89     :db-kind :join
  90     :db-info (:join-class employee-address
  91                           :home-key emplid
  92                           :foreign-key aemplid
  93                           :target-slot address
  94                           :set t)))
  95   (:base-table employee))
  96
  97 (def-view-class company ()
  98   ((companyid
  99     :db-kind :key
 100     :db-constraints :not-null
 101     :type integer
 102     :initarg :companyid)
 103    (groupid
 104     :db-kind :key
 105     :db-constraints :not-null
 106     :type integer
 107     :initarg :groupid)
 108    (name
 109     :type (string 100)
 110     :initarg :name)
 111    (presidentid
 112     :type integer
 113     :initarg :presidentid)
 114    (president
 115     :reader president
 116     :db-kind :join
 117     :db-info (:join-class employee
 118                           :home-key presidentid
 119                           :foreign-key emplid
 120                           :set nil))
 121    (employees
 122     :reader company-employees
 123     :db-kind :join
 124     :db-info (:join-class employee
 125                           :home-key (companyid groupid)
 126                           :foreign-key (ecompanyid groupid)
 127                           :set t))))
 128
 129 (def-view-class address ()
 130   ((addressid
 131     :db-kind :key
 132     :db-constraints :not-null
 133     :type integer
 134     :initarg :addressid)
 135    (street-number
 136     :type integer
 137     :initarg :street-number)
 138    (street-name
 139     :type (string 30)
 140     :void-value ""
 141     :initarg :street-name)
 142    (city
 143     :column "city_field"
 144     :void-value "no city"
 145     :type (string 30)
 146     :initarg :city)
 147    (postal-code
 148     :column zip
 149     :type integer
 150     :void-value 0
 151     :initarg :postal-code))
 152   (:base-table addr))
 153
 154 ;; many employees can reside at many addressess
 155 (def-view-class employee-address ()
 156   ((aemplid :type integer :initarg :emplid)
 157    (aaddressid :type integer :initarg :addressid)
 158    (verified :type boolean :initarg :verified)
 159    (address :db-kind :join
 160             :db-info (:join-class address
 161                                   :home-key aaddressid
 162                                   :foreign-key addressid
 163                                   :retrieval :immediate)))
 164   (:base-table "ea_join"))
 165
 166 (defun test-connect-to-database (db-type spec)
 167   (when (clsql-sys:db-backend-has-create/destroy-db? db-type)
 168     (ignore-errors (destroy-database spec :database-type db-type))
 169     (ignore-errors (create-database spec :database-type db-type)))
 170
 171   (setf *test-database-type* db-type)
 172   (when (>= (length spec) 3)
 173     (setq *test-database-user* (third spec)))
 174
 175   ;; Connect to the database
 176   (clsql:connect spec
 177                  :database-type db-type
 178                  :make-default t
 179                  :if-exists :old)
 180
 181   ;; Ensure database is empty
 182   (truncate-database :database *default-database*)
 183
 184   (setf *test-database-underlying-type*
 185         (clsql-sys:database-underlying-type *default-database*))
 186
 187   *default-database*)
 188
 189 (defparameter company1 nil)
 190 (defparameter employee1 nil)
 191 (defparameter employee2 nil)
 192 (defparameter employee3 nil)
 193 (defparameter employee4 nil)
 194 (defparameter employee5 nil)
 195 (defparameter employee6 nil)
 196 (defparameter employee7 nil)
 197 (defparameter employee8 nil)
 198 (defparameter employee9 nil)
 199 (defparameter employee10 nil)
 200 (defparameter address1 nil)
 201 (defparameter address2 nil)
 202 (defparameter employee-address1 nil)
 203 (defparameter employee-address2 nil)
 204 (defparameter employee-address3 nil)
 205 (defparameter employee-address4 nil)
 206 (defparameter employee-address5 nil)
 207
 208 (defun test-initialise-database ()
 209   (test-basic-initialize)
 210
 211   (let ((*backend-warning-behavior*
 212          (if (member *test-database-type* '(:postgresql :postgresql-socket))
 213              :ignore
 214            :warn)))
 215     (clsql:create-view-from-class 'employee)
 216     (clsql:create-view-from-class 'company)
 217     (clsql:create-view-from-class 'address)
 218     (clsql:create-view-from-class 'employee-address))
 219
 220   (let ((*db-auto-sync* t))
 221     (setf company1 (make-instance 'company
 222                                   :presidentid 1
 223                                   :companyid 1
 224                                   :groupid 1
 225                                   :name "Widgets Inc.")
 226           employee1 (make-instance 'employee
 227                                    :emplid 1
 228                                    :groupid 1
 229                                    :married t
 230                                    :height (1+ (random 1.00))
 231                                    :birthday (clsql:get-time)
 232                                    :first-name "Vladamir"
 233                                    :last-name "Lenin"
 234                                    :email "lenin@soviet.org"
 235                                    :companyid 1)
 236           employee2 (make-instance 'employee
 237                                    :emplid 2
 238                                    :groupid 1
 239                                    :height (1+ (random 1.00))
 240                                    :married t
 241                                    :birthday (clsql:get-time)
 242                                    :first-name "Josef"
 243                                    :last-name "Stalin"
 244                                    :email "stalin@soviet.org"
 245                                    :managerid 1
 246                                    :companyid 1)
 247           employee3 (make-instance 'employee
 248                                    :emplid 3
 249                                    :groupid 1
 250                                    :height (1+ (random 1.00))
 251                                    :married t
 252                                    :birthday (clsql:get-time)
 253                                    :first-name "Leon"
 254                                    :last-name "Trotsky"
 255                                    :email "trotsky@soviet.org"
 256                                    :managerid 1
 257                                    :companyid 1)
 258           employee4 (make-instance 'employee
 259                                    :emplid 4
 260                                    :groupid 1
 261                                    :height (1+ (random 1.00))
 262                                    :married nil
 263                                    :birthday (clsql:get-time)
 264                                    :first-name "Nikita"
 265                                    :last-name "Kruschev"
 266                                    :email "kruschev@soviet.org"
 267                                    :managerid 1
 268                                    :companyid 1)
 269           employee5 (make-instance 'employee
 270                                    :emplid 5
 271                                    :groupid 1
 272                                    :married nil
 273                                    :height (1+ (random 1.00))
 274                                    :birthday (clsql:get-time)
 275                                    :first-name "Leonid"
 276                                    :last-name "Brezhnev"
 277                                    :email "brezhnev@soviet.org"
 278                                    :managerid 1
 279                                    :companyid 1)
 280           employee6 (make-instance 'employee
 281                                    :emplid 6
 282                                    :groupid 1
 283                                    :married nil
 284                                    :height (1+ (random 1.00))
 285                                    :birthday (clsql:get-time)
 286                                    :first-name "Yuri"
 287                                    :last-name "Andropov"
 288                                    :email "andropov@soviet.org"
 289                                    :managerid 1
 290                                    :companyid 1)
 291           employee7 (make-instance 'employee
 292                                    :emplid 7
 293                                    :groupid 1
 294                                    :height (1+ (random 1.00))
 295                                    :married nil
 296                                    :birthday (clsql:get-time)
 297                                    :first-name "Konstantin"
 298                                    :last-name "Chernenko"
 299                                    :email "chernenko@soviet.org"
 300                                    :managerid 1
 301                                    :companyid 1)
 302           employee8 (make-instance 'employee
 303                                    :emplid 8
 304                                    :groupid 1
 305                                    :height (1+ (random 1.00))
 306                                    :married nil
 307                                    :birthday (clsql:get-time)
 308                                    :first-name "Mikhail"
 309                                    :last-name "Gorbachev"
 310                                    :email "gorbachev@soviet.org"
 311                                    :managerid 1
 312                                    :companyid 1)
 313           employee9 (make-instance 'employee
 314                                    :emplid 9
 315                                    :groupid 1
 316                                    :married nil
 317                                    :height (1+ (random 1.00))
 318                                    :birthday (clsql:get-time)
 319                                    :first-name "Boris"
 320                                    :last-name "Yeltsin"
 321                                    :email "yeltsin@soviet.org"
 322                                    :managerid 1
 323                                    :companyid 1)
 324           employee10 (make-instance 'employee
 325                                     :emplid 10
 326                                     :groupid 1
 327                                     :married nil
 328                                     :height (1+ (random 1.00))
 329                                     :birthday (clsql:get-time)
 330                                     :first-name "Vladamir"
 331                                     :last-name "Putin"
 332                                     :email "putin@soviet.org"
 333                                     :managerid 1
 334                                     :companyid 1)
 335           address1 (make-instance 'address
 336                                   :addressid 1
 337                                   :street-number 10
 338                                   :street-name "Park Place"
 339                                   :city "Leningrad"
 340                                   :postal-code 123)
 341           address2 (make-instance 'address
 342                                   :addressid 2)
 343           employee-address1 (make-instance 'employee-address
 344                                            :emplid 1
 345                                            :addressid 1
 346                                            :verified t)
 347           employee-address2 (make-instance 'employee-address
 348                                            :emplid 2
 349                                            :addressid 2
 350                                            :verified t)
 351           employee-address3 (make-instance 'employee-address
 352                                            :emplid 3
 353                                            :addressid 1
 354                                            :verified nil)
 355           employee-address4 (make-instance 'employee-address
 356                                            :emplid 1
 357                                            :addressid 2
 358                                            :verified nil)
 359           employee-address5 (make-instance 'employee-address
 360                                            :emplid 3
 361                                            :addressid 2)
 362           ))
 363
 364   ;; sleep to ensure birthdays are no longer at current time
 365   (sleep 1)
 366
 367   #||
 368   ;; Lenin manages everyone
 369   (clsql:add-to-relation employee2 'manager employee1)
 370   (clsql:add-to-relation employee3 'manager employee1)
 371   (clsql:add-to-relation employee4 'manager employee1)
 372   (clsql:add-to-relation employee5 'manager employee1)
 373   (clsql:add-to-relation employee6 'manager employee1)
 374   (clsql:add-to-relation employee7 'manager employee1)
 375   (clsql:add-to-relation employee8 'manager employee1)
 376   (clsql:add-to-relation employee9 'manager employee1)
 377   (clsql:add-to-relation employee10 'manager employee1)
 378   ;; Everyone works for Widgets Inc.
 379   (clsql:add-to-relation company1 'employees employee1)
 380   (clsql:add-to-relation company1 'employees employee2)
 381   (clsql:add-to-relation company1 'employees employee3)
 382   (clsql:add-to-relation company1 'employees employee4)
 383   (clsql:add-to-relation company1 'employees employee5)
 384   (clsql:add-to-relation company1 'employees employee6)
 385   (clsql:add-to-relation company1 'employees employee7)
 386   (clsql:add-to-relation company1 'employees employee8)
 387   (clsql:add-to-relation company1 'employees employee9)
 388   (clsql:add-to-relation company1 'employees employee10)
 389   ;; Lenin is president of Widgets Inc.
 390   (clsql:add-to-relation company1 'president employee1)
 391   ||#
 392
 393   ;; store these instances
 394   #||
 395   (clsql:update-records-from-instance employee1)
 396   (clsql:update-records-from-instance employee2)
 397   (clsql:update-records-from-instance employee3)
 398   (clsql:update-records-from-instance employee4)
 399   (clsql:update-records-from-instance employee5)
 400   (clsql:update-records-from-instance employee6)
 401   (clsql:update-records-from-instance employee7)
 402   (clsql:update-records-from-instance employee8)
 403   (clsql:update-records-from-instance employee9)
 404   (clsql:update-records-from-instance employee10)
 405   (clsql:update-records-from-instance company1)
 406   (clsql:update-records-from-instance address1)
 407   (clsql:update-records-from-instance address2)
 408   ||#
 409   )
 410
 411 (defvar *error-count* 0)
 412 (defvar *error-list* nil)
 413
 414 (defun run-function-append-report-file (function report-file)
 415     (let* ((report-path (etypecase report-file
 416                         (pathname report-file)
 417                         (string (parse-namestring report-file))))
 418          (sexp-report-path (make-pathname :defaults report-path
 419                                           :type "sexp")))
 420       (with-open-file (rs report-path :direction :output
 421                           :if-exists :append
 422                       :if-does-not-exist :create)
 423         (with-open-file (srs sexp-report-path :direction :output
 424                              :if-exists :append
 425                              :if-does-not-exist :create)
 426           (funcall function :report-stream rs :sexp-report-stream srs)))))
 427
 428 (defun run-tests-append-report-file (report-file)
 429   (run-function-append-report-file 'run-tests report-file))
 430
 431
 432 (defun run-tests (&key (report-stream *standard-output*) (sexp-report-stream nil))
 433   (let ((specs (read-specs))
 434         (*report-stream* report-stream)
 435         (*sexp-report-stream* sexp-report-stream)
 436         (*error-count* 0)
 437         (*error-list* nil))
 438     (unless specs
 439       (warn "Not running tests because test configuration file is missing")
 440       (return-from run-tests :skipped))
 441     (load-necessary-systems specs)
 442     (dolist (db-type +all-db-types+)
 443       (dolist (spec (db-type-spec db-type specs))
 444         (do-tests-for-backend db-type spec))))
 445   (zerop *error-count*))
 446
 447 (defun load-necessary-systems (specs)
 448   (dolist (db-type +all-db-types+)
 449     (when (db-type-spec db-type specs)
 450       (clsql-sys:initialize-database-type :database-type db-type))))
 451
 452 (defun write-report-banner (report-type db-type stream)
 453   (format stream
 454           "~&
 455 ******************************************************************************
 456 ***     CLSQL ~A begun at ~A
 457 ***     ~A
 458 ***     ~A on ~A
 459 ***     Database ~A backend~A.
 460 ******************************************************************************
 461 "
 462           report-type
 463           (clsql:format-time
 464            nil
 465            (clsql:utime->time (get-universal-time)))
 466           (lisp-implementation-type)
 467           (lisp-implementation-version)
 468           (machine-type)
 469           db-type
 470           (if (not (eq db-type *test-database-underlying-type*))
 471               (format nil " with underlying type ~A"
 472                       *test-database-underlying-type*)
 473               "")
 474           ))
 475
 476 (defun do-tests-for-backend (db-type spec)
 477   (test-connect-to-database db-type spec)
 478
 479   (unwind-protect
 480        (multiple-value-bind (test-forms skip-tests)
 481           (compute-tests-for-backend db-type *test-database-underlying-type*)
 482
 483          (write-report-banner "Test Suite" db-type *report-stream*)
 484
 485         (test-initialise-database)
 486
 487         (regression-test:rem-all-tests)
 488         (dolist (test-form test-forms)
 489           (eval test-form))
 490
 491         (let ((remaining (regression-test:do-tests *report-stream*)))
 492           (when (regression-test:pending-tests)
 493             (incf *error-count* (length remaining))))
 494
 495         (let ((sexp-error (list db-type
 496                                 *test-database-underlying-type*
 497                                 (get-universal-time)
 498                                 (length test-forms)
 499                                 (regression-test:pending-tests)
 500                                 (lisp-implementation-type)
 501                                 (lisp-implementation-version)
 502                                 (machine-type))))
 503           (when *sexp-report-stream*
 504             (write sexp-error :stream *sexp-report-stream*))
 505           (push sexp-error *error-list*))
 506
 507         (format *report-stream* "~&Tests skipped:")
 508         (if skip-tests
 509             (dolist (skipped skip-tests)
 510               (format *report-stream*
 511                       "~&   ~20A ~A~%" (car skipped) (cdr skipped)))
 512           (format *report-stream* " None~%")))
 513     (disconnect)))
 514
 515
 516 (defun compute-tests-for-backend (db-type db-underlying-type)
 517   (declare (ignorable db-type))
 518   (let ((test-forms '())
 519         (skip-tests '()))
 520     (dolist (test-form (append (test-basic-forms)
 521                                *rt-connection* *rt-fddl* *rt-fdml*
 522                                *rt-ooddl* *rt-oodml* *rt-syntax*))
 523       (let ((test (second test-form)))
 524         (cond
 525           ((and (null (clsql-sys:db-type-has-views? db-underlying-type))
 526                 (clsql-sys:in test :fddl/view/1 :fddl/view/2 :fddl/view/3 :fddl/view/4))
 527            (push (cons test "views not supported") skip-tests))
 528           ((and (null (clsql-sys:db-type-has-boolean-where? db-underlying-type))
 529                 (clsql-sys:in test :fdml/select/11 :oodml/select/5))
 530            (push (cons test "boolean where not supported") skip-tests))
 531           ((and (null (clsql-sys:db-type-has-subqueries? db-underlying-type))
 532                 (clsql-sys:in test :fdml/select/5 :fdml/select/10))
 533            (push (cons test "subqueries not supported") skip-tests))
 534           ((and (null (clsql-sys:db-type-transaction-capable? db-underlying-type
 535                                                     *default-database*))
 536                 (clsql-sys:in test :fdml/transaction/1 :fdml/transaction/2 :fdml/transaction/3 :fdml/transaction/4))
 537            (push (cons test "transactions not supported") skip-tests))
 538           ((and (null (clsql-sys:db-type-has-fancy-math? db-underlying-type))
 539                 (clsql-sys:in test :fdml/select/1))
 540            (push (cons test "fancy math not supported") skip-tests))
 541           ((and (eql *test-database-type* :sqlite)
 542                 (clsql-sys:in test :fddl/view/4 :fdml/select/10
 543                                 :fdml/select/21))
 544            (push (cons test "not supported by sqlite") skip-tests))
 545           ((and (eql *test-database-underlying-type* :mysql)
 546                 (clsql-sys:in test :fdml/select/22 :fdml/query/5
 547                                 :fdml/query/7 :fdml/query/8))
 548            (push (cons test "not supported by mysql") skip-tests))
 549           (t
 550            (push test-form test-forms)))))
 551       (values (nreverse test-forms) (nreverse skip-tests))))
 552
 553
 554 (defun rapid-load (type)
 555   "Rapid load for interactive testing."
 556   (when *default-database*
 557       (disconnect :database *default-database*))
 558   (test-connect-to-database type (car (db-type-spec type (read-specs))))
 559   (test-initialise-database))
 560
 561 (defun rl ()
 562   (rapid-load :postgresql))
 563
 564 (defun rlm ()
 565   (rapid-load :mysql))
 566
 567 (defun rlo ()
 568   (rapid-load :odbc))