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 (def-view-class deferred-employee-address ()
 167   ((aemplid :type integer :initarg :emplid)
 168    (aaddressid :type integer :initarg :addressid)
 169    (verified :type boolean :initarg :verified)
 170    (address :db-kind :join
 171             :db-info (:join-class address
 172                                   :home-key aaddressid
 173                                   :foreign-key addressid
 174                                   :retrieval :deferred)))
 175   (:base-table "ea_join"))
 176
 177 (defun test-connect-to-database (db-type spec)
 178   (when (clsql-sys:db-backend-has-create/destroy-db? db-type)
 179     (ignore-errors (destroy-database spec :database-type db-type))
 180     (ignore-errors (create-database spec :database-type db-type)))
 181
 182   (setf *test-database-type* db-type)
 183   (when (>= (length spec) 3)
 184     (setq *test-database-user* (third spec)))
 185
 186   ;; Connect to the database
 187   (clsql:connect spec
 188                  :database-type db-type
 189                  :make-default t
 190                  :if-exists :old)
 191
 192   ;; Ensure database is empty
 193   (truncate-database :database *default-database*)
 194
 195   (setf *test-database-underlying-type*
 196         (clsql-sys:database-underlying-type *default-database*))
 197
 198   *default-database*)
 199
 200 (defparameter company1 nil)
 201 (defparameter employee1 nil)
 202 (defparameter employee2 nil)
 203 (defparameter employee3 nil)
 204 (defparameter employee4 nil)
 205 (defparameter employee5 nil)
 206 (defparameter employee6 nil)
 207 (defparameter employee7 nil)
 208 (defparameter employee8 nil)
 209 (defparameter employee9 nil)
 210 (defparameter employee10 nil)
 211 (defparameter address1 nil)
 212 (defparameter address2 nil)
 213 (defparameter employee-address1 nil)
 214 (defparameter employee-address2 nil)
 215 (defparameter employee-address3 nil)
 216 (defparameter employee-address4 nil)
 217 (defparameter employee-address5 nil)
 218
 219 (defun test-initialise-database ()
 220   (test-basic-initialize)
 221
 222   (let ((*backend-warning-behavior*
 223          (if (member *test-database-type* '(:postgresql :postgresql-socket))
 224              :ignore
 225            :warn)))
 226     (clsql:create-view-from-class 'employee)
 227     (clsql:create-view-from-class 'company)
 228     (clsql:create-view-from-class 'address)
 229     (clsql:create-view-from-class 'employee-address))
 230
 231   (let ((*db-auto-sync* t))
 232     (setf company1 (make-instance 'company
 233                                   :presidentid 1
 234                                   :companyid 1
 235                                   :groupid 1
 236                                   :name "Widgets Inc.")
 237           employee1 (make-instance 'employee
 238                                    :emplid 1
 239                                    :groupid 1
 240                                    :married t
 241                                    :height (1+ (random 1.00))
 242                                    :birthday (clsql:get-time)
 243                                    :first-name "Vladamir"
 244                                    :last-name "Lenin"
 245                                    :email "lenin@soviet.org"
 246                                    :companyid 1)
 247           employee2 (make-instance 'employee
 248                                    :emplid 2
 249                                    :groupid 1
 250                                    :height (1+ (random 1.00))
 251                                    :married t
 252                                    :birthday (clsql:get-time)
 253                                    :first-name "Josef"
 254                                    :last-name "Stalin"
 255                                    :email "stalin@soviet.org"
 256                                    :managerid 1
 257                                    :companyid 1)
 258           employee3 (make-instance 'employee
 259                                    :emplid 3
 260                                    :groupid 1
 261                                    :height (1+ (random 1.00))
 262                                    :married t
 263                                    :birthday (clsql:get-time)
 264                                    :first-name "Leon"
 265                                    :last-name "Trotsky"
 266                                    :email "trotsky@soviet.org"
 267                                    :managerid 1
 268                                    :companyid 1)
 269           employee4 (make-instance 'employee
 270                                    :emplid 4
 271                                    :groupid 1
 272                                    :height (1+ (random 1.00))
 273                                    :married nil
 274                                    :birthday (clsql:get-time)
 275                                    :first-name "Nikita"
 276                                    :last-name "Kruschev"
 277                                    :email "kruschev@soviet.org"
 278                                    :managerid 1
 279                                    :companyid 1)
 280           employee5 (make-instance 'employee
 281                                    :emplid 5
 282                                    :groupid 1
 283                                    :married nil
 284                                    :height (1+ (random 1.00))
 285                                    :birthday (clsql:get-time)
 286                                    :first-name "Leonid"
 287                                    :last-name "Brezhnev"
 288                                    :email "brezhnev@soviet.org"
 289                                    :managerid 1
 290                                    :companyid 1)
 291           employee6 (make-instance 'employee
 292                                    :emplid 6
 293                                    :groupid 1
 294                                    :married nil
 295                                    :height (1+ (random 1.00))
 296                                    :birthday (clsql:get-time)
 297                                    :first-name "Yuri"
 298                                    :last-name "Andropov"
 299                                    :email "andropov@soviet.org"
 300                                    :managerid 1
 301                                    :companyid 1)
 302           employee7 (make-instance 'employee
 303                                    :emplid 7
 304                                    :groupid 1
 305                                    :height (1+ (random 1.00))
 306                                    :married nil
 307                                    :birthday (clsql:get-time)
 308                                    :first-name "Konstantin"
 309                                    :last-name "Chernenko"
 310                                    :email "chernenko@soviet.org"
 311                                    :managerid 1
 312                                    :companyid 1)
 313           employee8 (make-instance 'employee
 314                                    :emplid 8
 315                                    :groupid 1
 316                                    :height (1+ (random 1.00))
 317                                    :married nil
 318                                    :birthday (clsql:get-time)
 319                                    :first-name "Mikhail"
 320                                    :last-name "Gorbachev"
 321                                    :email "gorbachev@soviet.org"
 322                                    :managerid 1
 323                                    :companyid 1)
 324           employee9 (make-instance 'employee
 325                                    :emplid 9
 326                                    :groupid 1
 327                                    :married nil
 328                                    :height (1+ (random 1.00))
 329                                    :birthday (clsql:get-time)
 330                                    :first-name "Boris"
 331                                    :last-name "Yeltsin"
 332                                    :email "yeltsin@soviet.org"
 333                                    :managerid 1
 334                                    :companyid 1)
 335           employee10 (make-instance 'employee
 336                                     :emplid 10
 337                                     :groupid 1
 338                                     :married nil
 339                                     :height (1+ (random 1.00))
 340                                     :birthday (clsql:get-time)
 341                                     :first-name "Vladamir"
 342                                     :last-name "Putin"
 343                                     :email "putin@soviet.org"
 344                                     :managerid 1
 345                                     :companyid 1)
 346           address1 (make-instance 'address
 347                                   :addressid 1
 348                                   :street-number 10
 349                                   :street-name "Park Place"
 350                                   :city "Leningrad"
 351                                   :postal-code 123)
 352           address2 (make-instance 'address
 353                                   :addressid 2)
 354           employee-address1 (make-instance 'employee-address
 355                                            :emplid 1
 356                                            :addressid 1
 357                                            :verified t)
 358           employee-address2 (make-instance 'employee-address
 359                                            :emplid 2
 360                                            :addressid 2
 361                                            :verified t)
 362           employee-address3 (make-instance 'employee-address
 363                                            :emplid 3
 364                                            :addressid 1
 365                                            :verified nil)
 366           employee-address4 (make-instance 'employee-address
 367                                            :emplid 1
 368                                            :addressid 2
 369                                            :verified nil)
 370           employee-address5 (make-instance 'employee-address
 371                                            :emplid 3
 372                                            :addressid 2)
 373           ))
 374
 375   ;; sleep to ensure birthdays are no longer at current time
 376   (sleep 1)
 377
 378   #||
 379   ;; Lenin manages everyone
 380   (clsql:add-to-relation employee2 'manager employee1)
 381   (clsql:add-to-relation employee3 'manager employee1)
 382   (clsql:add-to-relation employee4 'manager employee1)
 383   (clsql:add-to-relation employee5 'manager employee1)
 384   (clsql:add-to-relation employee6 'manager employee1)
 385   (clsql:add-to-relation employee7 'manager employee1)
 386   (clsql:add-to-relation employee8 'manager employee1)
 387   (clsql:add-to-relation employee9 'manager employee1)
 388   (clsql:add-to-relation employee10 'manager employee1)
 389   ;; Everyone works for Widgets Inc.
 390   (clsql:add-to-relation company1 'employees employee1)
 391   (clsql:add-to-relation company1 'employees employee2)
 392   (clsql:add-to-relation company1 'employees employee3)
 393   (clsql:add-to-relation company1 'employees employee4)
 394   (clsql:add-to-relation company1 'employees employee5)
 395   (clsql:add-to-relation company1 'employees employee6)
 396   (clsql:add-to-relation company1 'employees employee7)
 397   (clsql:add-to-relation company1 'employees employee8)
 398   (clsql:add-to-relation company1 'employees employee9)
 399   (clsql:add-to-relation company1 'employees employee10)
 400   ;; Lenin is president of Widgets Inc.
 401   (clsql:add-to-relation company1 'president employee1)
 402   ||#
 403
 404   ;; store these instances
 405   #||
 406   (clsql:update-records-from-instance employee1)
 407   (clsql:update-records-from-instance employee2)
 408   (clsql:update-records-from-instance employee3)
 409   (clsql:update-records-from-instance employee4)
 410   (clsql:update-records-from-instance employee5)
 411   (clsql:update-records-from-instance employee6)
 412   (clsql:update-records-from-instance employee7)
 413   (clsql:update-records-from-instance employee8)
 414   (clsql:update-records-from-instance employee9)
 415   (clsql:update-records-from-instance employee10)
 416   (clsql:update-records-from-instance company1)
 417   (clsql:update-records-from-instance address1)
 418   (clsql:update-records-from-instance address2)
 419   ||#
 420   )
 421
 422 (defvar *error-count* 0)
 423 (defvar *error-list* nil)
 424
 425 (defun run-function-append-report-file (function report-file)
 426     (let* ((report-path (etypecase report-file
 427                         (pathname report-file)
 428                         (string (parse-namestring report-file))))
 429          (sexp-report-path (make-pathname :defaults report-path
 430                                           :type "sexp")))
 431       (with-open-file (rs report-path :direction :output
 432                           :if-exists :append
 433                       :if-does-not-exist :create)
 434         (with-open-file (srs sexp-report-path :direction :output
 435                              :if-exists :append
 436                              :if-does-not-exist :create)
 437           (funcall function :report-stream rs :sexp-report-stream srs)))))
 438
 439 (defun run-tests-append-report-file (report-file)
 440   (run-function-append-report-file 'run-tests report-file))
 441
 442
 443 (defun run-tests (&key (report-stream *standard-output*) (sexp-report-stream nil))
 444   (let ((specs (read-specs))
 445         (*report-stream* report-stream)
 446         (*sexp-report-stream* sexp-report-stream)
 447         (*error-count* 0)
 448         (*error-list* nil))
 449     (unless specs
 450       (warn "Not running tests because test configuration file is missing")
 451       (return-from run-tests :skipped))
 452     (load-necessary-systems specs)
 453     (dolist (db-type +all-db-types+)
 454       (dolist (spec (db-type-spec db-type specs))
 455         (do-tests-for-backend db-type spec))))
 456   (zerop *error-count*))
 457
 458 (defun load-necessary-systems (specs)
 459   (dolist (db-type +all-db-types+)
 460     (when (db-type-spec db-type specs)
 461       (clsql-sys:initialize-database-type :database-type db-type))))
 462
 463 (defun write-report-banner (report-type db-type stream)
 464   (format stream
 465           "~&
 466 ******************************************************************************
 467 ***     CLSQL ~A begun at ~A
 468 ***     ~A
 469 ***     ~A on ~A
 470 ***     Database ~A backend~A.
 471 ******************************************************************************
 472 "
 473           report-type
 474           (clsql:format-time
 475            nil
 476            (clsql:utime->time (get-universal-time)))
 477           (lisp-implementation-type)
 478           (lisp-implementation-version)
 479           (machine-type)
 480           db-type
 481           (if (not (eq db-type *test-database-underlying-type*))
 482               (format nil " with underlying type ~A"
 483                       *test-database-underlying-type*)
 484               "")
 485           ))
 486
 487 (defun do-tests-for-backend (db-type spec)
 488   (test-connect-to-database db-type spec)
 489
 490   (unwind-protect
 491        (multiple-value-bind (test-forms skip-tests)
 492           (compute-tests-for-backend db-type *test-database-underlying-type*)
 493
 494          (write-report-banner "Test Suite" db-type *report-stream*)
 495
 496         (test-initialise-database)
 497
 498         (regression-test:rem-all-tests)
 499         (dolist (test-form test-forms)
 500           (eval test-form))
 501
 502         (let ((remaining (regression-test:do-tests *report-stream*)))
 503           (when (regression-test:pending-tests)
 504             (incf *error-count* (length remaining))))
 505
 506         (let ((sexp-error (list db-type
 507                                 *test-database-underlying-type*
 508                                 (get-universal-time)
 509                                 (length test-forms)
 510                                 (regression-test:pending-tests)
 511                                 (lisp-implementation-type)
 512                                 (lisp-implementation-version)
 513                                 (machine-type))))
 514           (when *sexp-report-stream*
 515             (write sexp-error :stream *sexp-report-stream* :readably t))
 516           (push sexp-error *error-list*))
 517
 518         (format *report-stream* "~&Tests skipped:")
 519         (if skip-tests
 520             (dolist (skipped skip-tests)
 521               (format *report-stream*
 522                       "~&   ~20A ~A~%" (car skipped) (cdr skipped)))
 523           (format *report-stream* " None~%")))
 524     (disconnect)))
 525
 526
 527 (defun compute-tests-for-backend (db-type db-underlying-type)
 528   (declare (ignorable db-type))
 529   (let ((test-forms '())
 530         (skip-tests '()))
 531     (dolist (test-form (append (test-basic-forms)
 532                                *rt-connection* *rt-fddl* *rt-fdml*
 533                                *rt-ooddl* *rt-oodml* *rt-syntax*))
 534       (let ((test (second test-form)))
 535         (cond
 536           ((and (null (clsql-sys:db-type-has-views? db-underlying-type))
 537                 (clsql-sys:in test :fddl/view/1 :fddl/view/2 :fddl/view/3 :fddl/view/4))
 538            (push (cons test "views not supported") skip-tests))
 539           ((and (null (clsql-sys:db-type-has-boolean-where? db-underlying-type))
 540                 (clsql-sys:in test :fdml/select/11 :oodml/select/5))
 541            (push (cons test "boolean where not supported") skip-tests))
 542           ((and (null (clsql-sys:db-type-has-subqueries? db-underlying-type))
 543                 (clsql-sys:in test :fdml/select/5 :fdml/select/10))
 544            (push (cons test "subqueries not supported") skip-tests))
 545           ((and (null (clsql-sys:db-type-transaction-capable? db-underlying-type
 546                                                     *default-database*))
 547                 (clsql-sys:in test :fdml/transaction/1 :fdml/transaction/2 :fdml/transaction/3 :fdml/transaction/4))
 548            (push (cons test "transactions not supported") skip-tests))
 549           ((and (null (clsql-sys:db-type-has-fancy-math? db-underlying-type))
 550                 (clsql-sys:in test :fdml/select/1))
 551            (push (cons test "fancy math not supported") skip-tests))
 552           ((and (eql *test-database-type* :sqlite)
 553                 (clsql-sys:in test :fddl/view/4 :fdml/select/10
 554                                 :fdml/select/21))
 555            (push (cons test "not supported by sqlite") skip-tests))
 556           ((and (eql *test-database-underlying-type* :mysql)
 557                 (clsql-sys:in test :fdml/select/22 :fdml/query/5
 558                                 :fdml/query/7 :fdml/query/8))
 559            (push (cons test "not supported by mysql") skip-tests))
 560           (t
 561            (push test-form test-forms)))))
 562       (values (nreverse test-forms) (nreverse skip-tests))))
 563
 564
 565 (defun rapid-load (type)
 566   "Rapid load for interactive testing."
 567   (when *default-database*
 568       (disconnect :database *default-database*))
 569   (test-connect-to-database type (car (db-type-spec type (read-specs))))
 570   (test-initialise-database))
 571
 572 (defun rl ()
 573   (rapid-load :postgresql))
 574
 575 (defun rlm ()
 576   (rapid-load :mysql))
 577
 578 (defun rlo ()
 579   (rapid-load :odbc))