samuelpordeus/vscode-elixir-test

Visual Studio Code extension to interact with elixir tests

Hi there 👋

vscode-elixir-test's Issues

Handle terminal already running command / multiple terminals

Hi! This extension is super handy!

This is just a small improvement suggestion - I'm not familiar with extension development so I'm not sure how difficult it would be.

Use case

I often have two terminal panes open, and one of them is often already running a command - iex, psql, etc. I'm not sure how this plugin chooses which terminal to use (first, maybe?) but if I execute any of the "run test" commands, it has a chance to try to inject the mix test ... command into my running application.

Suggested changes

• It would probably be a good idea to have the extension refuse to insert text into a terminal pane when that terminal pane is already running a command (other than the shell). One can imagine potentially disastrous scenarios where commands are executed in unexpected environments.
• If more than one terminal is open, perhaps loop through the open terminals until a "valid candidate" (i.e., not running another command already) is found.

Support multiple projects

I'm working in a multi-project setting, like so:

root (no mix file)
- ProjectA (mix project)
- ProjectB (mix project)
- ProjectC (no mix project)

When I run the tests in ProjectA or ProjectB I'm getting:
** (Mix) Could not find a Mix.Project, please ensure you are running Mix in a directory with a mix.exs file

I'm assuming this is because it's looking for the mix file in the root.

When I cd into the project directory it works. It's just a shame I have to switch back and forth.

It would be great to support mono repos with multiple mix projects in it.

Thoughts?

Extension opens a different test file

I have the following project structure:

lib/
  api.ex
tools/
  api.ex

The lib/api.ex file doesn't have any test file. But if I try to open it, the extension will open the test for tools/api.ex

Add configurable keybindings that do the jump

It doesn't work on umbrella apps

If you are willing to solve this issue, update the README as well 😬

Run test that the cursor is currently on

Create a command that opens vs-code terminal and run on the root folder:

mix test "path-of-the-current-file:line-that-the-cursor-is-on"

Scroll the terminal when a new test command is run

If we scroll the terminal up it is not scrolled back down if we run another test command.
It is a nit but I think it's a nice UX detail.

GIF

Would be convenient to manage the create test template via config

vscode-elixir-test/src/commands/jumpToTest.js

Line 32 in b18e913

ws.insert(

Even just using something like

defmodule <%= @module_name %> do
  @moduledoc """
  Test for `<%= @module_name %>`.
  """
  
  use ExUnit.Case, async: true

  alias <%= @module_name %> 

<% for {module, fun, arity} <- @mfas do %> 
  describe ".<%= fun_name %>/<%= arity %>" do
    test "given valid params" do
      assert <%= @module_alias %>.<%= fun_name %>() == true
    end
  end
<% end>
end

Connect to vscode-test-explorer

Hi,

vscode test explorer is a cool extension to visualize the tests.

Is it possible to connected this extension to it ?

Thanks

Jump falsely shows pop-up "create test" in workspace

Love the extension.

I'm running into a bug when I'm using the extension in a vs workspace.

When I jump between implementation and code, the pop-up ("Do you want to create test") shows up every time even though an exist already exists.

When I click create, it switches to the implementation just fine.

See here:
https://recordit.co/NX9OXo8MkL

Wrong path separator when running through WSL

I'm on Windows (don't ask) running WSL (with Ubuntu) and VSCode.

As VSCode is running as a Windows application (but using the linux filesystem), the generated path when using the command 'Elixir Test: Run all tests on file' contains all backslashes. This doesn't work as the linux filesystem expects forward slashes.

Is it possible to make the path separator configurable as a setting? Or maybe use the already existing setting explorer.copyRelativePathSeparator?

Add a `when` in the keybinding

The value could be editorTextFocus && editorLangId == 'elixir'

Create tests

I didn't touch the test suite that the vs-code extensions boilerplate gave me. Would be really nice to have some tests kicking on 😃

This extension hates the name "testing"

If I have a module in a directory called "testing", vscode-elixir-test wants to create test files in lib/PROJECT/libing.

And then after successfully moving the files to the right directory, trying to jump back runs into the same issue.

Make "run test" commands more DRY

There is a lot of repeated code on the 3 runTest commands. A refactor would be nice!

It doesn't work when using a default mix app

@GuSilverFlame tried to test it on a simple mix project and it blew everything! 💥

Add the definition of the module when creating a new test file

When we create a new test file it'll be nice to add a simple template in this file, like:

defmodule Foo.BarTest do
end

Should we change the focus to the terminal?

We always change the focus to the terminal if we run a command to run the tests and at least for my flow where I like to iterate quickly (do a change, run the test, do another change ad infinitum...) is kind of an annoyance to have to focus on the test file.

Maybe we should provide some sort of config for this behavior?

How to run last test?

There is a shortcut to repeat the last test?

thanks

Run all tests of the currently opened file

Create a command that opens vs-code terminal and run a mix test "path-of-the-current-file" on the root folder

Terminal does not open when running a test

With version 1.8.x, when I try to run a test, the terminal does not open. I have to manually open it in order to see the test run. I like to keep side panels closed when I'm not using them. After downgrading to version 1.7.1, the terminal opens automatically.

Add a message warning when there isn't a matching test

Tip 😬:

window.showInformationMessage('content');

[Suggestion] Use watcher for tests

Implement integration with mix_test_watcher library to auto test everytime we save the code.

Maybe, we can use the library directly from extension?

Umbrella: run test for individual apps or all apps

When running the test suite on a umbrella app, I want to be able to run mix test in the current app or in the umbrella's root.

I usually run tests for individual apps during development and run tests for the whole project before pushing code.

Run tests in folder

I saw it in the extension Rails Test Runner and I think it'll be a good idea to implement it in this extension as well, take a look:

It appears when I right-click in some folder of the project

Reorganize code structure

Everything is inside one single file, it's becoming hard to maintain this project.

Run the whole test suite

Create a command that opens vs-code terminal and run a mix test on the root folder

keyword argument must be followed by space after: exs:

I'm receiving this error whenever I run test at cursor

TypeError: Cannot read properties of undefined (reading 'length')

I recently received the update to vscode-elixir-test, and this error happens when I try to run tests:

In Extension Host:

2023-11-20 16:51:39.616 [error] TypeError: Cannot read properties of undefined (reading 'length')
    at mix (/Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/helpers/mix.js:7:47)
    at Object.testPath (/Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/helpers/mix.js:36:10)
    at /Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/commands/runTestFile.js:5:46
    at Object.onTestFile (/Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/helpers/test.js:39:17)
    at Object.handler (/Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/commands/runTestFile.js:5:8)
    at /Users/mstratto/.vscode/extensions/samuel-pordeus.elixir-test-1.8.0/src/extension.js:13:25

Downgrading to version 1.7.1 resolves the problem.

Run eslint on TravisCI

As to enforce a consistent style.

Ask if the user wants to create a test when there isn't one

Add to Open VSX Registry

It would be great if this were listed on the Open VSX Registry. This allows other editors such as Oni Vim use the extension. I think anyone can add this to the registry, but this may be something that you want to control.

Consider more "jumps"? Maybe in a new extension?

I just discovered this extension over the weekend and am loving it.

I do wonder if there is value in moving the jumping behavior into it's own extension? Thinking aloud, maybe I'd want to jump from a controller to a view or from a method to a template?

Not sure if I'll have an opportunity to help out but wanted to share my thoughts. Thanks again!

Default keybinding to run tests conflicts with built-in shortcut

On Linux and Windows, the keyboard binding ctrl + shift + k is already mapped by default in VS Code as "Delete Line". I use this shortcut all the time. I'm on Linux.

• https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf
• https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf

I just installed the Elixir Test extension and it broke my keybinding.

Consider changing the default keybinding? Otherwise users have to know to re-map it.

Prefix MIX_ENV variable for mix test command

Is there an actual way to set a MIX_ENV=test prefix before the mix test command?

Create either `module_test.exs` or `module.ex` conditionally based on the caller file

Execute from module.ex

• Write file module_test.exs ✔️

Execute from module_test.exs

• Write file module_test_test.exs ❌

Expected:

• Write file module.ex ✔️

Tests do not run - TypeError: Cannot read properties of undefined (reading 'replace')

The extension stopped working for me, and I believe it was after a VSCodium update.

Steps to reproduce

1. Have VSCodium 1.84.2 and elixir-text 1.8.1 installed.
2. Try to "Run all tests on file".

Expected behavior

• Tests should run.

Actual behavior

• I see an error (under "Extension Host") stating the following:

2023-11-29 23:01:09.229 [error] TypeError: Cannot read properties of undefined (reading 'replace')
    at Re.sendText (vscode-file://vscode-app/opt/vscodium-bin/resources/app/out/vs/workbench/workbench.desktop.main.js:2610:2043)
    at s.$sendText (vscode-file://vscode-app/opt/vscodium-bin/resources/app/out/vs/workbench/workbench.desktop.main.js:1687:61417)

Jump between test file and actual file not working im module name also contains "Test"

When in a file wrong_test_file_extension.ex and trying to jumpo to wrong_test_file_extension_test.exs, it tries to jump somewhere it can't find (probably wrong_file_extension_test.exs ).

It is probably this part of the code that is responsible, since it just assumes that nothing will ever have "_test" in the filename anywhere except an actual test:

vscode-elixir-test/src/commands/jumpToTest.js

Line 100 in c79c607

const strippedFileName = fileName.replace('_test', '');

Ensure that if an opened terminal is not on the workspace root folder it navigates to it

Discussed on #24

As it is right now, for both commands involving the vs-code terminal, we open a new terminal when there isn't one already opened. But if there is, we don't ensure that it's on the root folder (from the workspace). And that could lead us into trouble.

We need to do something like this:

if not root -> cd to_root
else -> do nothing

Optionally use a preferred terminal

Sometimes I trigger the shortcut to run the test, but my terminal is attached to a iex, tig or something else, and it does not work because it tries to run the mix command inside the iex, for example.

Could the extension open a new terminal when it's the case? It can be an optional flag on the extension config.

Create elixir test snippets

Currently we don't have snippets when typing any test syntax to create tests on elixir.

It would be good to have some snippets when typing describe, or test, for example to already create a block of a test example. Something like:

• When typing describe

describe "function/artity" do
  test "description" do
  
  end
end

Update "Elixir Jump to Test" extension into "Elixir Test"

Let's pivot our extension and do some epic changes 💥!

We are planning to add a few more features related to test to this extension:

• Run test that the cursor is currently on
• Run all tests on the currently opened file
• Run the whole test suite

For that reason, we need to change its name to something more generic, and the chosen name was Elixir Test!

Add CircleCI

Create a logo for the extension

Our beloved extension does not have a logo 🙁

This StackOverflow answer here explains how to add one.

If you are willing to create a logo and add it, that would be very nice 😬

Open VSX Listing: Signing the Publisher Agreement

Thank you for being part of the Open VSX community by adding your extensions to the Open VSX Registry. Please note that the service was recently transferred to the Eclipse Foundation and urgent action on your part is needed so we can continue to list your extensions. To ensure uninterrupted service, please sign the Eclipse Publisher Agreement as soon as possible.

Regrettably, if not soon, your extensions will be delisted and will no longer appear on the site nor be available via the API. If you sign at a later date, your extensions will then be re-activated. The signing process is explained in the Wiki (steps 1 and 2).

Please also note that all extensions MUST have a license in order to be listed.

Claiming ownership of the namespace for your extension(s): We also recommend you do this. To find out how to do this, see:
https://github.com/eclipse/openvsx/wiki/Namespace-Access

Useful links:
Eclipse Publisher Agreement
Eclipse Foundation Open VSX Registry Frequently Asked Questions (FAQ)

More details are in these recent blog posts:
https://blogs.eclipse.org/post/brian-king/open-vsx-registry-under-new-management
https://blogs.eclipse.org/post/brian-king/new-era-open-vsx-registry

Today, there’s growing momentum around open source tools and technologies that support Visual Studio (VS) Code extensions. Leading global organizations are adopting these tools and technologies. This momentum has spurred demand for a marketplace without restrictions and limitations. Thanks for joining us on this journey as we continue to build the Open VSX community.
We look forward to continued innovation from you in 2021!