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