Tests fail if run from under a target directory

[lread]

Expected behavior

As part of rewrite-clj canary testing, I extract a copy of refactor-nrepl source code somewhere beneath rewrite-clj's target directory.

When I run

make test

I should see all tests pass.

Actual behavior

I see the following test failures:

...

FAIL in (source-files-with-clj-like-extension-test) (core_test.clj:45)
expected: (pos? (count (filter (fn [f] (-> f .getPath (.endsWith extension))) result)))
  actual: (not (pos? 0))

lein test :only refactor-nrepl.core-test/source-files-with-clj-like-extension-test

FAIL in (source-files-with-clj-like-extension-test) (core_test.clj:45)
expected: (pos? (count (filter (fn [f] (-> f .getPath (.endsWith extension))) result)))
  actual: (not (pos? 0))

lein test :only refactor-nrepl.core-test/source-files-with-clj-like-extension-test

FAIL in (source-files-with-clj-like-extension-test) (core_test.clj:45)
expected: (pos? (count (filter (fn [f] (-> f .getPath (.endsWith extension))) result)))
  actual: (not (pos? 0))

...

FAIL in (sorts-by-frequencies) (form-init11474675976321826582.clj:32)
expected: (= (first utils) (quote refactor-nrepl.util))
  actual: (not (= nil refactor-nrepl.util))

lein test :only refactor-nrepl.ns.namespace-aliases-test/libspecs-are-cached

FAIL in (libspecs-are-cached) (form-init11474675976321826582.clj:42)
expected: (thrown-with-msg? Exception #"Expected!" (sut/namespace-aliases false))
  actual: nil

...

Ran 130 tests containing 29599 assertions.
5 failures, 0 errors.
Tests failed.
Error encountered performing task 'test' with profile(s): 'base,system,provided,dev,1.10,config'
Tests failed.
make: *** [test] Error 1

If I instead don't have target in my path all tests pass.

Steps to reproduce the problem

mkdir -p foobar/target
cd foobar/target
git clone https://github.com/clojure-emacs/refactor-nrepl.git
cd refactor-nrepl
git reset v3.0.0 --hard
make test

You will see tests fail, but if you then:

cd ../..
mv target ok
cd ok/refactor-nrepl
make test

You will see tests pass.

Environment & Version information

clj-refactor.el and refactor-nrepl version information

Running tests from v3.0.0 tag clone of this repository.

CIDER version information

n/a

Leiningen or Boot version

❯ lein --version
Leiningen 2.9.7 on Java 11.0.13 OpenJDK 64-Bit Server VM

Emacs version

n/a

Operating system

macOS 10.15.7

Diagnosis

This was working for refactor-nrepl 2.5.1.

I think the issue is likely caused by new classpath exclusion techniques:

refactor-nrepl/src/refactor_nrepl/core.clj

Lines 62 to 72 in a3f9de8

	(defn source-dirs-on-classpath
	"Like `#'dirs-on-classpath`, but restricted to dirs that look like
	(interesting) source/test dirs."
	[]
	(->> (dirs-on-classpath)
	(remove (fn [^File f]
	(let [s (-> f .toString)]
	(or (-> s (.contains "resources"))
	(-> s (.contains "target"))
	(-> s (.contains ".gitlibs"))))))
	(remove util/dir-outside-root-dir?)))

which excludes any path that contains target or resources (I'm guessing that .gitlibs is less important).

I raised this issue in case it might be affecting your broader user base.
If it is only affecting my particular use case, I can find a work-around for rewrite-clj canary testing.

[vemv]

Thanks for the heads up!

I extract a copy of refactor-nrepl source code somewhere beneath rewrite-clj's target directory

Honestly I don't think there's a legitimate use case for this. target/ is not where a given project's source is expected to reside.

refactor-nrepl intentionally excludes anything residing under target/ for both avoiding superfluous errors and speeding up analysis.

Therefore I'd recommend to run the test suite under a more realistic setting (which, can be argued, is an improvement for rewrite-clj's canary testing, i.e. not merely a workaround).

Cheers - V

[lread]

Thanks for the reply @vemv.

Honestly I don't think there's a legitimate use case for this. target/ is not where the a given project's source is expected to reside.

I find that folks put stuff wherever they put stuff.
Build/test work happens under target, and this is test work for rewrite-clj.
But, I can do my canary tests under an alternate dir without any fuss at all.

My primary goal was to be a good citizen by alerting you to a potentially larger problem for your user base.
If this is not the case, please feel free to close this issue.

[vemv]

My primary goal was to be a good citizen by alerting you to a potentially larger problem for your user base.

Yes, understood and appreciated 👍

Have a great one!

[lread]

Who knows, poor old Timothy Arget, or Ryan Emert Steven Ources might have usernames that prohibit the use of refactor-nrepl! (more tongue in cheek than making a point, but still making a bit of a point).

[vemv]

That's a good call, .contains could be .endsWith

[lread]

All my best arguments are jokes. 🙂

[lread]

Another idle thought: I suppose it might be odd, but a CI server could plunk your code wherever too.