Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Capture logs in tests instead of redefining log* (#83962)

Chris Truter5f8b99ba7d90
diff --git a/enterprise/backend/test/metabase_enterprise/transforms_python/job_test.clj b/enterprise/backend/test/metabase_enterprise/transforms_python/job_test.clj
index 256d96f5298..b9d36465781 100644
--- a/enterprise/backend/test/metabase_enterprise/transforms_python/job_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/transforms_python/job_test.clj
@@ -1,9 +1,6 @@
(ns ^:mb/driver-tests ^:mb/transforms-python-test metabase-enterprise.transforms-python.job-test
(:require
[clojure.test :refer :all]
- ;; tests redef log/log* to capture log lines; util.log macros bottom out in tools.logging
- ^{:clj-kondo/ignore [:discouraged-namespace]}
- [clojure.tools.logging :as log]
[metabase.driver :as driver]
[metabase.task.core :as task]
[metabase.test :as mt]
@@ -58,21 +55,19 @@
(let [python-transform {:id 2
:source python-source
:name "Test Python Transform"}
- run-id 101
- logged-messages (atom [])]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged-messages conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)]
- (#'jobs/run-transform! {:parent-run [:job run-id]
- :run-method :scheduled
- :user-id nil
- :add-run-activity! (constantly nil)}
- (promise)
- python-transform)
- (is (= 1 (count @logged-messages))
- "Should log exactly one warning")
- (is (= :warn (:level (first @logged-messages)))
- "Should log at warn level")
- (is (re-matches #".*Skip running transform 2 due to lacking premium features.*"
- (:message (first @logged-messages)))
- "Warning message should indicate transform was skipped due to missing features"))))))
+ run-id 101]
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)]
+ (#'jobs/run-transform! {:parent-run [:job run-id]
+ :run-method :scheduled
+ :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise)
+ python-transform)
+ (is (= 1 (count (messages)))
+ "Should log exactly one warning")
+ (is (= :warn (:level (first (messages))))
+ "Should log at warn level")
+ (is (re-matches #".*Skip running transform 2 due to lacking premium features.*"
+ (:message (first (messages))))
+ "Warning message should indicate transform was skipped due to missing features")))))))
diff --git a/test/metabase/sso/common_test.clj b/test/metabase/sso/common_test.clj
index 200b82b5996..3fb85c62dea 100644
--- a/test/metabase/sso/common_test.clj
+++ b/test/metabase/sso/common_test.clj
@@ -1,9 +1,6 @@
(ns metabase.sso.common-test
(:require
[clojure.test :refer :all]
- ;; redefs clojure.tools.logging/log* to capture log calls; util.log macros bottom out there
- ^{:clj-kondo/ignore [:discouraged-namespace]}
- [clojure.tools.logging]
[metabase.permissions.core :as perms]
[metabase.permissions.models.permissions-group :as perms-group]
[metabase.sso.common :as integrations.common]
@@ -133,24 +130,19 @@
(deftest sync-groups-test-10
(testing "Make sure the delete last admin exception is catched"
- (mt/with-log-level :warn
+ (mt/with-log-messages-for-level [messages :warn]
(mt/with-user-in-groups [user [(perms-group/admin)]]
- (let [log-warn-count (atom #{})]
- (mt/with-dynamic-fn-redefs [t2/delete!
- (fn [model & _args]
- (when (= model :model/PermissionsGroupMembership)
- (throw (ex-info (str perms/fail-to-remove-last-admin-msg)
- {:status-code 400}))))
- clojure.tools.logging/log*
- (fn [_logger level _throwable msg]
- (when (:= level :warn)
- (swap! log-warn-count conj msg)))]
- ;; make sure sync run without throwing exception
- (integrations.common/sync-group-memberships! user #{} #{(perms-group/admin)})
- ;; make sure we log a msg for that
- (is (@log-warn-count
- (str "Attempted to remove the last admin during group sync! "
- "Check your SSO group mappings and make sure the Administrators group is mapped correctly.")))))))))
+ (mt/with-dynamic-fn-redefs [t2/delete!
+ (fn [model & _args]
+ (when (= model :model/PermissionsGroupMembership)
+ (throw (ex-info (str perms/fail-to-remove-last-admin-msg)
+ {:status-code 400}))))]
+ ;; make sure sync run without throwing exception
+ (integrations.common/sync-group-memberships! user #{} #{(perms-group/admin)})
+ ;; make sure we log a msg for that
+ (is (some #{(str "Attempted to remove the last admin during group sync! "
+ "Check your SSO group mappings and make sure the Administrators group is mapped correctly.")}
+ (map :message (messages)))))))))
(deftest sync-groups-2-arity-unchanged-memberships-test
(testing "2-arity version: does syncing group memberships leave existing memberships in place if nothing has changed?"
diff --git a/test/metabase/transforms/jobs_test.clj b/test/metabase/transforms/jobs_test.clj
index e2bda8cc3a5..337c8a2802f 100644
--- a/test/metabase/transforms/jobs_test.clj
+++ b/test/metabase/transforms/jobs_test.clj
@@ -1,10 +1,7 @@
(ns ^:mb/driver-tests metabase.transforms.jobs-test
- ;; raw tools.logging is required so tests can redef log/log* and capture log output
- #_{:clj-kondo/ignore [:discouraged-namespace]}
(:require
[clojure.string :as str]
[clojure.test :refer :all]
- [clojure.tools.logging :as log]
[metabase.config.core :as config]
[metabase.driver :as driver]
[metabase.driver.sql.util :as sql.u]
@@ -137,41 +134,37 @@
:source query-source
:name "Test Query Transform"}
run-id 102
- logged-messages (atom [])
run-called? (atom false)]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged-messages conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)
- transforms.execute/execute! (fn [_ _]
- (reset! run-called? true))]
- (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
- :add-run-activity! (constantly nil)}
- (promise) query-transform)
- (is (empty? (filter (comp #{:warn} :level) @logged-messages))
- "Should not log warnings when feature is enabled")
- (is @run-called?
- "Should call run-mbql-transform! when feature is enabled"))))))
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)
+ transforms.execute/execute! (fn [_ _]
+ (reset! run-called? true))]
+ (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise) query-transform)
+ (is (empty? (filter (comp #{:warn} :level) (messages)))
+ "Should not log warnings when feature is enabled")
+ (is @run-called?
+ "Should call run-mbql-transform! when feature is enabled")))))))
(deftest run-query-transform-skipped-hosted-without-basic-feature-test
(mt/with-premium-features #{:hosting}
(let [query-transform {:id 1
:source query-source
:name "Test Query Transform"}
- run-id 100
- logged-messages (atom [])]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged-messages conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)]
- (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
- :add-run-activity! (constantly nil)}
- (promise) query-transform)
- (is (= 1 (count @logged-messages))
- "Should log exactly one warning")
- (is (= :warn (:level (first @logged-messages)))
- "Should log at warn level")
- (is (re-matches #".*Skip running transform 1 due to lacking premium features.*"
- (:message (first @logged-messages)))
- "Warning message should indicate transform was skipped due to missing features")))))
+ run-id 100]
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)]
+ (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise) query-transform)
+ (is (= 1 (count (messages)))
+ "Should log exactly one warning")
+ (is (= :warn (:level (first (messages))))
+ "Should log at warn level")
+ (is (re-matches #".*Skip running transform 1 due to lacking premium features.*"
+ (:message (first (messages))))
+ "Warning message should indicate transform was skipped due to missing features"))))))
(deftest run-query-transform-with-transforms-basic-feature-test
(mt/with-premium-features #{:hosting :transforms-basic}
@@ -179,20 +172,18 @@
:source query-source
:name "Test Query Transform"}
run-id 102
- logged-messages (atom [])
run-called? (atom false)]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged-messages conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)
- transforms.execute/execute! (fn [_ _]
- (reset! run-called? true))]
- (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
- :add-run-activity! (constantly nil)}
- (promise) query-transform)
- (is (empty? (filter (comp #{:warn} :level) @logged-messages))
- "Should not log warnings when feature is enabled")
- (is @run-called?
- "Should call run-mbql-transform! when feature is enabled")))))
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)
+ transforms.execute/execute! (fn [_ _]
+ (reset! run-called? true))]
+ (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise) query-transform)
+ (is (empty? (filter (comp #{:warn} :level) (messages)))
+ "Should not log warnings when feature is enabled")
+ (is @run-called?
+ "Should call run-mbql-transform! when feature is enabled"))))))
(deftest run-query-transform-skipped-when-transforms-enabled-false-test
(mt/with-temporary-raw-setting-values [transforms-enabled "false"]
@@ -201,25 +192,23 @@
:source query-source
:name "Disabled Transform"}
run-id 103
- logged-messages (atom [])
run-called? (atom false)]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged-messages conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)
- transforms.execute/execute! (fn [_ _]
- (reset! run-called? true))]
- (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
- :add-run-activity! (constantly nil)}
- (promise) query-transform)
- (is (= 1 (count @logged-messages))
- "Should log exactly one warning")
- (is (= :warn (:level (first @logged-messages)))
- "Should log at warn level")
- (is (re-matches #".*Skip running transform 4 due to lacking premium features.*"
- (:message (first @logged-messages)))
- "Warning message should indicate transform was skipped")
- (is (false? @run-called?)
- "Should not execute when transforms-enabled is explicitly false"))))))
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)
+ transforms.execute/execute! (fn [_ _]
+ (reset! run-called? true))]
+ (#'jobs/run-transform! {:parent-run [:job run-id] :run-method :scheduled :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise) query-transform)
+ (is (= 1 (count (messages)))
+ "Should log exactly one warning")
+ (is (= :warn (:level (first (messages))))
+ "Should log at warn level")
+ (is (re-matches #".*Skip running transform 4 due to lacking premium features.*"
+ (:message (first (messages))))
+ "Warning message should indicate transform was skipped")
+ (is (false? @run-called?)
+ "Should not execute when transforms-enabled is explicitly false")))))))
(deftest run-transform-locked-meter-test
;; `transform-metered-as` is `defenterprise`; the OSS impl returns nil for everything,
@@ -238,21 +227,19 @@
:source_type :native
:source query-source
:name "Locked Transform"}
- logged (atom [])
run-called? (atom false)]
- (mt/with-dynamic-fn-redefs [log/log* (fn [_ level _ message]
- (swap! logged conj {:level level :message message}))
- transform-run/running-run-for-transform-id (constantly nil)
- transforms.execute/execute! (fn [_ _] (reset! run-called? true))]
- (#'jobs/run-transform! {:parent-run [:job 200] :run-method :scheduled :user-id nil
- :add-run-activity! (constantly nil)}
- (promise) transform)
- (is (false? @run-called?)
- "execute! must not be called when the meter is locked")
- (is (some #(re-matches #".*Skip running transform 7 due to locked meter.*"
- (:message %))
- @logged)
- "Should log warning naming the locked-meter reason"))))))
+ (mt/with-log-messages-for-level [messages [metabase.transforms.jobs :warn]]
+ (mt/with-dynamic-fn-redefs [transform-run/running-run-for-transform-id (constantly nil)
+ transforms.execute/execute! (fn [_ _] (reset! run-called? true))]
+ (#'jobs/run-transform! {:parent-run [:job 200] :run-method :scheduled :user-id nil
+ :add-run-activity! (constantly nil)}
+ (promise) transform)
+ (is (false? @run-called?)
+ "execute! must not be called when the meter is locked")
+ (is (some #(re-matches #".*Skip running transform 7 due to locked meter.*"
+ (:message %))
+ (messages))
+ "Should log warning naming the locked-meter reason")))))))
(testing "scheduled run-transform! runs normally when the meter is not locked"
(mt/with-premium-features #{:hosting :transforms-basic}
(mt/with-temporary-setting-values [locked-meters {:transform-basic-runs false}]