org-roam/tests/test-org-roam-perf.el

;;; test-org-roam-perf.el --- Performance Tests for Org-roam -*- lexical-binding: t; -*-

;; Copyright (C) 2020 Jethro Kuan

;; Author: Jethro Kuan <jethrokuan95@gmail.com>
;; Package-Requires: ((buttercup))

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:
;;; Code:

(require 'buttercup)
(require 'org-roam)

(defconst test-org-roam-perf-zip-url "https://github.com/org-roam/test-org-files/archive/master.zip"
  "Path to zip for test org-roam files.")

(defun test-org-roam-perf--abs-path (file-path)
  "Get absolute FILE-PATH from `org-roam-directory'."
  (file-truename (expand-file-name file-path org-roam-directory)))

(defun test-org-roam-perf--init ()
  "."
  (let* ((temp-loc (expand-file-name (make-temp-name "test-org-files-") temporary-file-directory))
         (zip-file-loc (concat temp-loc ".zip"))
         (_ (url-copy-file test-org-roam-perf-zip-url zip-file-loc))
         (_ (shell-command (format "mkdir -p %s && unzip -j -qq %s -d %s" temp-loc zip-file-loc temp-loc))))
    (setq org-roam-directory temp-loc)))

(describe "Cache Build"
  (it "cache build from scratch time to be acceptable"
    (test-org-roam-perf--init)
    (pcase (benchmark-run 1 (org-roam-db-build-cache t))
      (`(,time ,gcs ,time-in-gc)
       (message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
       (expect time :to-be-less-than 100))))
  (it "builds quickly without change"
    (pcase (benchmark-run 1 (org-roam-db-build-cache))
      (`(,time ,gcs ,time-in-gc)
       (message "Elapsed time: %fs (%fs in %d GCs)" time time-in-gc gcs)
       (expect time :to-be-less-than 5)))))