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