helix 0.6.0 (new formula) #93816

henryhchchc · 2022-01-26T08:56:58Z

Have you followed the guidelines for contributing?
Have you ensured that your commits follow the commit style guide?
Have you checked that there aren't other open pull requests for the same formula update/change?
- I did and I found helix 0.5.0 (new formula) #92085, which was opened two months ago and outdated.
Have you built your formula locally with brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
Does your build pass brew audit --strict <formula> (after doing brew install --build-from-source <formula>)? If this is a new formula, does it pass brew audit --new <formula>?

SMillerDev · 2022-01-26T08:59:11Z

Formula/helix.rb

+  end
+
+  test do
+    assert_match version.to_s, shell_output("#{bin}/hx --version")


We need a test that exercises the some of the functionality of the app. Version checks or usage checks (foo --version or foo --help) are not sufficient, as explained in the formula cookbook.

In most cases, a good test would involve running a simple test case: run #{bin}/foo input.txt.

Then you can check that the output is as expected (with assert_equal or assert_match on the output of shell_output)

You can also check that an output file was created, if that is expected: assert_predicate testpath/"output.txt", :exist?

Some advice for specific cases:

If the formula is a library, compile and run some simple code that links against it. It could be taken from upstream's documentation / source examples.

If the formula is for a GUI program, try to find some function that runs as command-line only, like a format conversion, reading or displaying a config file, etc.

If the software cannot function without credentials, a test could be to try to connect with invalid credentials (or without credentials) and confirm that it fails as expected.

Same if the software requires a virtual machine, docker instance, etc. to be running.

The case for Helix is a little bit different. Actually the output of hx --help is

helix-term v0.6.0 Blaž Hrastnik <[email protected]> A post-modern text editor. USAGE: hx [FLAGS] [files]... ARGS: <files>... Sets the input file to use FLAGS: -h, --help Prints help information --tutor Loads the tutorial -v Increases logging verbosity each use for up to 3 times (default file: /Users/<user>/.cache/helix/helix.log) -V, --version Prints version information

Unlike vim or nevim, Helix has not yet provide a headless mode, which enables the test script to perform operations without blocking the execution. I think -h or -V are currently the only two options that can output something without blocking the execution.

Alternatively, do you think it a good idea if we run hx -v and check whether the log file exists?

If it's a program that runs in the terminal can't you just open it, wait a bit and send an exit command?

Thanks for the suggestions. Looks like Helix does not provide a way for sending commands externally. I am not sure whether SIGINT is considered as one. I may need some references, is there any other formulas having a test script doing that?

See for example https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/kondo.rb

Thanks but unfortunately, writing to stdin can not tell Helix to exit since it handles stdin its own way. Currently the way I do the testing is that:

On macOS, I try to write some content to stdin and check for the error message produced.

On Linux, I start the program, write something to stdin (the content will be in the editor buffer), wait for 5 seconds, make sure the process is still alive (otherwise kill will exit with 1), and kill it.

carlocab · 2022-01-26T09:05:35Z

Formula/helix.rb

+  url "https://github.com/helix-editor/helix.git",
+       tag:      "v0.6.0",
+       revision: "ac1b7d8d0a608f47edfee2872d414e94fd26cc31"


Do we need a git clone? Can we use a tarball instead?

I think so. There are 55 submodules need to be fetched for building the binary, which are not available in the tarball.

carlocab · 2022-01-26T09:09:32Z

Formula/helix.rb

+    mv bin/"hx", bin/"hx-bin"
+    (bin/"hx").write_env_script(bin/"hx-bin", HELIX_RUNTIME: prefix/"runtime")


Suggested change

mv bin/"hx", bin/"hx-bin"

(bin/"hx").write_env_script(bin/"hx-bin", HELIX_RUNTIME: prefix/"runtime")

bin.env_script_all_files libexec/"bin", HELIX_RUNTIME: prefix/"runtime"

Is there any reason for you to be able to run hx without HELIX_RUNTIME set?

Thanks for the suggestion. I was not aware of the convenient function provided by Homebrew lol.

As for the reason for setting HELIX_RUNTIME , it is mentioned in https://github.com/helix-editor/helix#installation that

Helix also needs its runtime files so make sure to copy/symlink the runtime/ directory into the
config directory (for example ~/.config/helix/runtime on Linux/macOS, or %AppData%/helix/runtime on Windows).
This location can be overridden via the HELIX_RUNTIME environment variable.

We have to install the runtime directory to the cellar and set the environment variable since we can not install it to the users' home directory.

BTW, I moved the runtime directory to libexec.

Judging by this it's more appropriate in etc

We have to install the runtime directory to the cellar and set the environment variable since we can not install it to the users' home directory.

I'm aware, but initially you installed hx without this environment variable set, which is why I asked if you ever want to be able to run hx without this set.

Judging by this it's more appropriate in etc

Probably not, because we can't ship updates to files in etc

archseer · 2022-02-02T15:10:37Z

Formula/helix.rb

+        stdin.write "test"
+        sleep 5.seconds
+        system "kill", "-SIGTERM", wait_thr.pid.to_s


I took a quick look at how the vim test works, perhaps we can do something similar if homebrew supports injecting keys:

homebrew-core/Formula/vim.rb

Lines 73 to 79 in 7df9f2a

(testpath/"commands.vim").write <<~EOS

:python3 import vim; vim.current.buffer[0] = 'hello python3'

:wq

EOS

system bin/"vim", "-T", "dumb", "-s", "commands.vim", "test.txt"

assert_equal "hello python3", File.read("test.txt").chomp

assert_match "+gettext", shell_output("#{bin}/vim --version")

i hello esc :wq test.txt

I don't think this is injecting keys. Actually in the test script of vim and neovim, they are creating a command script (i.e., commands.vim) and feed it to the editor. Unfortunately I don't see such feature in Helix (based on the latest release).

we can do something similar if homebrew supports injecting keys

I agree, and looks like sending key sequences is the only way we can control Helix in the test script.

You can use Ruby's PTY module if you want to inject keys.

Thanks for the advice. I tried the following test script but hx still hangs. When I replace bin/"hx" with "vim", it just works. Maybe I am not using the right key sequences to control Helix. I need some help (maybe from @archseer, who is a contributor of Helix).

P.S.: When I type the key sequences manually on my keyboard, Helix works as expected.

test do require "pty" require "io/console" test_file = testpath / "test.txt" r, w, pid = PTY.spawn bin/"hx", test_file r.winsize = [80, 43] sleep 1 w.write "itest\e" sleep 1 w.write ":wq\n" sleep 1 Process.wait(pid) assert_equal "test", test_file.read.chomp end

@henryhchchc can you try enabling r.raw! right after spawning?

We also expect the terminal to be a tty: https://github.com/helix-editor/helix/blob/d62ad8b595a4f901b9c5dba1bb6e8f70ece395bf/helix-term/src/application.rs#L147-L153

But that should be handled by PTY?

Formula/helix.rb

Co-authored-by: Carlo Cabrera <[email protected]>

github-actions · 2022-02-24T23:18:55Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

helix 0.6.0 (new formula)

238eb16

BrewTestBot added new formula PR adds a new formula to Homebrew/homebrew-core rust Rust use is a significant feature of the PR or issue labels Jan 26, 2022

SMillerDev reviewed Jan 26, 2022

View reviewed changes

carlocab reviewed Jan 26, 2022

View reviewed changes

henryhchchc added 2 commits January 26, 2022 17:28

helix 0.6.0 (formula refactorings)

c58b72e

helix 0.6.0 (update test block for new formula)

73148eb

henryhchchc force-pushed the helix-new-formula branch from 0aca0d7 to 73148eb Compare January 26, 2022 11:55

matoous mentioned this pull request Feb 2, 2022

helix 0.5.0 (new formula) #92085

Closed

6 tasks

archseer reviewed Feb 2, 2022

View reviewed changes

helix: modified test script

a3ce094

carlocab reviewed Feb 3, 2022

View reviewed changes

Formula/helix.rb Outdated Show resolved Hide resolved

helix: Fixed test script based on review

e913cff

Co-authored-by: Carlo Cabrera <[email protected]>

github-actions bot added the stale No recent activity label Feb 24, 2022

github-actions bot closed this Mar 4, 2022

henryhchchc deleted the helix-new-formula branch March 22, 2022 06:40

archseer mentioned this pull request Apr 6, 2022

Add Linux support helix-editor/homebrew-helix#5

Merged

the-mikedavis mentioned this pull request Apr 8, 2022

Bad CPU type in helix editor executable after installing from brew cask on M1 Mac helix-editor/helix#1997

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

helix 0.6.0 (new formula) #93816

helix 0.6.0 (new formula) #93816

henryhchchc commented Jan 26, 2022

SMillerDev Jan 26, 2022

henryhchchc Jan 26, 2022 •

edited

Loading

SMillerDev Jan 26, 2022

henryhchchc Jan 26, 2022

SMillerDev Jan 26, 2022

henryhchchc Jan 26, 2022

carlocab Jan 26, 2022

henryhchchc Jan 26, 2022

carlocab Jan 26, 2022

henryhchchc Jan 26, 2022

SMillerDev Jan 26, 2022

carlocab Jan 26, 2022

archseer Feb 2, 2022

henryhchchc Feb 3, 2022

carlocab Feb 3, 2022

henryhchchc Feb 3, 2022 •

edited

Loading

archseer Mar 4, 2022

archseer Mar 4, 2022

github-actions bot commented Feb 24, 2022

		mv bin/"hx", bin/"hx-bin"
		(bin/"hx").write_env_script(bin/"hx-bin", HELIX_RUNTIME: prefix/"runtime")

	mv bin/"hx", bin/"hx-bin"
	(bin/"hx").write_env_script(bin/"hx-bin", HELIX_RUNTIME: prefix/"runtime")
	bin.env_script_all_files libexec/"bin", HELIX_RUNTIME: prefix/"runtime"

	(testpath/"commands.vim").write <<~EOS
	:python3 import vim; vim.current.buffer[0] = 'hello python3'
	:wq
	EOS
	system bin/"vim", "-T", "dumb", "-s", "commands.vim", "test.txt"
	assert_equal "hello python3", File.read("test.txt").chomp
	assert_match "+gettext", shell_output("#{bin}/vim --version")

helix 0.6.0 (new formula) #93816

helix 0.6.0 (new formula) #93816

Conversation

henryhchchc commented Jan 26, 2022

Choose a reason for hiding this comment

henryhchchc Jan 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

henryhchchc Feb 3, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 24, 2022

henryhchchc Jan 26, 2022 •

edited

Loading

henryhchchc Feb 3, 2022 •

edited

Loading