more-speech/spec/more_speech/migrator_spec.clj

(ns more-speech.migrator-spec
  (:require [speclj.core :refer :all]
            [more-speech.migrator :refer :all]
            [more-speech.config :as config]
            [clojure.java.io :as io]
            [more-speech.user-configuration :as user-configuration]))

(defn change-to-tmp-files []
  (reset! config/private-directory "tmp")
  (reset! config/migration-filename "tmp/migration")
  (reset! config/nicknames-filename "tmp/nicknames")        ;grandfathered
  (reset! config/profiles-filename "tmp/profiles")
  (reset! config/keys-filename "tmp/keys")
  (reset! config/relays-filename "tmp/relays")
  (reset! config/read-event-ids-filename "tmp/read-event-ids")
  (reset! config/tabs-filename "tmp/tabs")
  (reset! config/tabs-list-filename "tmp/tabs-list")
  (reset! config/messages-directory "tmp/messages")
  (reset! config/messages-filename "tmp/messages/message-file")
  (reset! config/user-configuration-filename "tmp/user-configuration")
  (.mkdir (io/file "tmp"))
  (prn 'changed-to-tmp)
  )


(defn delete-all-files-in [dir]
  (let [files (.listFiles (io/file dir))]
    (doseq [file files]
      (let [fname (str dir "/" (.getName file))]
        (delete-file fname))))
  )

(defn delete-all-tmp-files []
  (delete-all-files-in "tmp/messages")
  (delete-all-files-in "tmp"))

(defn revert-from-tmp []
  (delete-all-tmp-files)
  (delete-file "tmp")
  (reset! config/private-directory "private")
  (reset! config/migration-filename "private/migration")
  (reset! config/nicknames-filename "private/nicknames")    ;grandfathered
  (reset! config/profiles-filename "private/profiles")
  (reset! config/keys-filename "private/keys")
  (reset! config/relays-filename "private/relays")
  (reset! config/read-event-ids-filename "private/read-event-ids")
  (reset! config/tabs-filename "private/tabs")
  (reset! config/tabs-list-filename "private/tabs-list")
  (reset! config/messages-directory "private/messages")
  (reset! config/messages-filename "private/messages/message-file")
  (reset! config/user-configuration-filename "private/user-configuration")
  )

(describe "The Migrator"
  (with-stubs)
  (before-all (change-to-tmp-files))
  (after (delete-all-tmp-files))
  (after-all (revert-from-tmp))

  (context "the migration framework"

    (it "returns zero if no migration file"
      (should= 0 (get-migration-level)))

    (it "reads the migration level"
      (should (file-exists? "tmp"))
      (set-migration-level 42)
      (should= 42 (get-migration-level)))

    (it "determines migrations to perform if no migration file"
      (should= [1 2 3 4] (get-needed-migrations 4)))

    (it "determines migrations to perform if level already set"
      (set-migration-level 10)
      (should= [11 12 13 14 15] (get-needed-migrations 15)))

    (it "throws exception if set level is greater than needed."
      (set-migration-level 10)
      (should-throw (get-needed-migrations 9)))

    (it "should not execute migrations if at current level"
      (set-migration-level 1)
      (reset! migrations {1 (stub :migration-one)})
      (migrate-to 1)
      (should-not-have-invoked :migration-one)
      (should= 1 (get-migration-level)))

    (it "should execute appropriate migrations if not at current level"
      (set-migration-level 1)
      (reset! migrations {1 (stub :migration-one)
                          2 (stub :migration-two)
                          3 (stub :migration-three)
                          4 (stub :migration-four)})
      (migrate-to 3)
      (should-not-have-invoked :migration-one)
      (should-have-invoked :migration-two)
      (should-have-invoked :migration-three)
      (should-not-have-invoked :migration-four)
      (should= 3 (get-migration-level)))

    (it "should complain if a migration function is missing"
      (set-migration-level 1)
      (reset! migrations {1 (stub :migration-one)
                          2 (stub :migration-two)
                          4 (stub :migration-four)})
      (should-throw Exception "Missing migrations [3]." (migrate-to 4))
      (should-not-have-invoked :migration-one)
      (should-not-have-invoked :migration-two)
      (should-not-have-invoked :migration-four))
    )

  (context "The initial migration"
    (it "creates all necessary files and warns about the key file if not present."
      (initial-migration)
      (should (file-exists? @config/keys-filename))
      (should (file-exists? @config/nicknames-filename))
      (should (file-exists? @config/relays-filename))
      (should (file-exists? @config/read-event-ids-filename))
      (should (file-exists? @config/tabs-filename))
      (prn (read-string (slurp @config/keys-filename)))
      )
    )

  (context "migration 2 - fix names"
    (it "fixes names"
      (with-redefs [rand-int (fn [_n] 12)]
        (let [bad-nicknames {1 "good-name"
                             2 "bad name"
                             3 "long-name0123456789"
                             4 ""
                             5 nil
                             6 "洛奇安"}]
          (spit @config/nicknames-filename bad-nicknames)
          (migration-2-fix-names)
          (let [nicknames (read-string (slurp @config/nicknames-filename))]
            (should= {1 "good-name"
                      2 "badname"
                      3 "long-name0123456789"
                      4 "dud-12"
                      5 "dud-12"
                      6 "dudx-12"}
                     nicknames))))))

  (context "migration 3"
    (it "adds messages directory and empty message-file"
      (migration-3-add-messages-directory)
      (should (file-exists? @config/messages-directory))
      (should (is-directory? @config/messages-directory))
      (should (file-exists? @config/messages-filename))
      (should= {} (read-string (slurp @config/messages-filename)))
      )
    )

  (context "migration 4"
    (it "Adds profiles file and copies nicknames into empty profiles."
      (let [nicknames {1 "bob"
                       2 "bill"
                       }]
        (spit @config/nicknames-filename nicknames))
      (migration-4-add-profiles-and-load-with-nicknames)
      (should (file-exists? @config/profiles-filename))
      (let [profiles (read-string (slurp @config/profiles-filename))]
        (should= {1 {:name "bob"}
                  2 {:name "bill"}} profiles))))

  (context "migration 5"
    (it "Removes the nicknames file."
      (spit @config/nicknames-filename {1 "user-1"})
      (migration-5-remove-nicknames)
      (should-not (file-exists? @config/nicknames-filename))))

  (context "migration 6 reformat tabs file into tabs-list file"
    (it "reformats the tabs file."
      (let [tabs-map {:tab1 {:selected [1] :blocked [2]}
                      :tab2 {:selected [3 4] :blocked [5 6]}}]
        (spit @config/tabs-filename tabs-map))
      (should-not (file-exists? @config/tabs-list-filename))
      (migration-6-reformat-tabs)
      (should (file-exists? @config/tabs-list-filename))
      (let [tabs-list (read-string (slurp @config/tabs-list-filename))]
        (should (vector? tabs-list))
        (should= #{{:name "tab1" :selected [1] :blocked [2]}
                   {:name "tab2" :selected [3 4] :blocked [5 6]}}
                 (set tabs-list))))

    (it "reformats an empty tabs file"
      (spit @config/tabs-filename {})
      (migration-6-reformat-tabs)
      (should= [] (read-string (slurp @config/tabs-list-filename)))
      (should-not (file-exists? @config/tabs-filename)))

    (it "creates an empty tabs-list if no tabs"
      (migration-6-reformat-tabs)
      (should= [] (read-string (slurp @config/tabs-list-filename)))
      )
    )

  (context "migration 7 break message-file into daily files"
    (it "breaks up message-file and deletes it"
      (.mkdir (io/file "tmp/messages"))
      (should (file-exists? @config/messages-directory))
      (let [messages {1 {:id 1 :created-at 0}
                      2 {:id 2 :created-at 86400}
                      }]
        (spit @config/messages-filename messages))
      (migration-7-break-messages-into-daily-files)
      (should (file-exists? (str @config/messages-directory "/" "0-01Jan70")))
      (should (file-exists? (str @config/messages-directory "/" "1-02Jan70")))
      (should= [{:id 1 :created-at 0}] (read-string (slurp (str @config/messages-directory "/0-01Jan70"))))
      (should= [{:id 2 :created-at 86400}] (read-string (slurp (str @config/messages-directory "/1-02Jan70"))))
      (should-not (file-exists? @config/messages-filename))))

  (context "migration 8 user configuration"
    (it "creates a valid user-configuration file"
      (migration-8-user-configuration)
      (should (file-exists? @config/user-configuration-filename))
      (should= (user-configuration/validate {})
               (read-string (slurp @config/user-configuration-filename))))
    )
  )