Merge pull request #8 from J3RN/add-tests

Add tests

Author: J3RN

.circleci/config.yml

@@ -0,0 +1,14 @@
+version: 2.1
+
+jobs:
+  test:
+    working_directory: /app
+    docker:
+      - image: ghcr.io/j3rn/emacs-elixir:v1
+    steps:
+      - checkout
+      - run: emacs -batch -l ert -l inf-elixir.el -l tests/inf-elixir-test.el -f ert-run-tests-batch-and-exit
+
+workflows:
+  test:
+    jobs: [test]

README.md

@@ -1,6 +1,7 @@
 # inf-elixir
 [![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt)
 [![MELPA](https://melpa.org/packages/inf-elixir-badge.svg)](https://melpa.org/#/inf-elixir)
+[![CircleCI status](https://circleci.com/gh/J3RN/inf-elixir.svg?style=svg)](https://app.circleci.com/pipelines/github/J3RN/inf-elixir)
 
 This is a package to allow you to pop open and interact with Elixir REPL (IEx, presently).
 
@@ -41,3 +42,18 @@ Once your installation is configured to use MELPA, `inf-elixir` can be installed
 An example of keybindings is included in the `use-package` declaration above.
 
 [badge-license]: https://img.shields.io/badge/license-GPL_3-green.svg
+
+## Development
+
+I am not yet using any kind of build tool (like [Eldev](https://github.com/doublep/eldev) or [Cask](https://github.com/cask/cask)) to develop this plugin. Generally speaking, working with the code involves:
+1. Clone the git repository
+2. Make some changes
+3. Load your changes with `M-x load-file RET inf-elixir.el RET`
+4. Verify your changes worked
+5. Send a PR :pray:
+
+There are some tests written with [ERT](https://www.gnu.org/software/emacs/manual/html_node/ert/index.html) that can be run with this command:
+
+```
+$ emacs -batch -l ert -l inf-elixir.el -l tests/inf-elixir-test.el -f ert-run-tests-batch-and-exit
+```

inf-elixir.el

@@ -164,10 +164,8 @@ Always returns a REPL buffer for DIR."
   "Create a new IEx buffer and run CMD in project DIR.
 
 DIR should be an absolute path to the root level of a Mix project (where the
-mix.exs file is).
-
-A value of nil for DIR indicates that the REPL should not belong to any
-project and should be created as a global REPL."
+mix.exs file is).  A value of nil for DIR indicates that the REPL should not
+belong to any project."
   (inf-elixir--maybe-kill-repl dir)
   (inf-elixir--maybe-clear-repl dir)
   (pop-to-buffer (inf-elixir--maybe-start-repl dir (split-string cmd))))

tests/inf-elixir-test.el

@@ -0,0 +1,92 @@
+;;; inf-elixir-test.el --- Inf-Elixir's test suite -*- lexical-binding: t -*-
+
+;;; Commentary:
+;; Inf-Elixir uses ERT for testing.
+;; Run tests with:
+;; $ emacs -batch -l ert -l inf-elixir.el -l tests/inf-elixir-test.el -f ert-run-tests-batch-and-exit
+
+;;; Code:
+
+(require 'inf-elixir)
+
+(defmacro inf-elixir-with-project (&rest body)
+  "Create an Elixir project directory and eval BODY there."
+  (let ((temp-dir (concat temporary-file-directory (file-name-as-directory "inf-elixir-test"))))
+    `(unwind-protect
+         (progn
+           (make-directory ,temp-dir)
+           (let ((default-directory ,temp-dir))
+             (with-temp-buffer
+               (insert "defmodule Foobar.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :foobar,
+      version: \"0.1.0\"
+    ]
+  end
+end")
+               (write-file "mix.exs"))
+             ,@body))
+       (when (file-directory-p ,temp-dir)
+         (delete-directory ,temp-dir t)))))
+
+(defmacro inf-elixir-with-cleanup (&rest body)
+  "Evaulate BODY and cleanup inf-elixir side-effects afterwards."
+  `(unwind-protect
+       (progn
+         ,@body)
+     (let ((kill-buffer-query-functions nil))
+       (when-let ((inf-elixir-buf (get-buffer "*Inf-Elixir*")))
+         (kill-buffer inf-elixir-buf))
+
+       (maphash
+        (lambda (proj buffer) (kill-buffer buffer))
+        inf-elixir-project-buffers)
+
+       (clrhash inf-elixir-project-buffers))))
+
+(ert-deftest inf-elixir-run-cmd ()
+  "`inf-elixir-run-cmd' opens new buffer running cmd."
+  (inf-elixir-with-cleanup
+   (inf-elixir-run-cmd nil "iex")
+   (should (process-live-p (get-buffer-process (current-buffer))))
+   (should (equal (buffer-name (current-buffer)) "*Inf-Elixir*"))
+   (should (equal
+            (process-command (get-buffer-process (current-buffer)))
+            '("iex")))))
+
+(ert-deftest inf-elixir-has-no-project ()
+  "The `inf-elixir' command does not associate REPL with a project."
+  (inf-elixir-with-cleanup
+   (inf-elixir)
+   (should (process-live-p (get-buffer-process (current-buffer))))
+   (should (equal (buffer-name (current-buffer)) "*Inf-Elixir*"))
+   (maphash
+    (lambda (proj buffer) (should-not (eq buffer (current-buffer))))
+    inf-elixir-project-buffers)))
+
+(ert-deftest inf-elixir-project-has-project ()
+  "The `inf-elixir-project' command associates a REPL with a project."
+  (inf-elixir-with-project
+   (inf-elixir-with-cleanup
+    (inf-elixir-project)
+    (should (process-live-p (get-buffer-process (current-buffer))))
+    (should (equal (buffer-name (current-buffer)) "*Inf-Elixir - inf-elixir-test*"))
+    (should (gethash default-directory inf-elixir-project-buffers)))))
+
+(ert-deftest inf-elixir-send-within-project ()
+  "`inf-elixir-send-line' sends text to a REPL within the project."
+  (inf-elixir-with-project
+   (inf-elixir-with-cleanup
+    (inf-elixir-project)
+    (while (not (string-match-p "iex(1)>" (buffer-string))) (sleep-for 0 10))
+    (with-temp-buffer
+      (insert "1 + 1")
+      (inf-elixir-send-line))
+    (sleep-for 0 500)
+    (should (string-match-p "iex(1)> 2" (buffer-string))))))
+
+(provide 'inf-elixir-test)
+;;; inf-elixir-test.el ends here