Entwicklungsumgebung unter Linux

[jbaesner]

Leider wird in der README.md zum Aufsetzen der Entwicklungsumgebung von einem Mac ausgegangen.

Mein Versuch die Entwicklungsumgebung für Solectrus unter Linux aufzusetzen war bisher leider nicht erfolgreich.

Aktuell scheitert es am Punkt 4. Setup the application to install gems and NPM packages and create the database:

Wenn ich bin/setup ausführe, kann libpq.so.5 nicht geöffnet werden:

== Installing dependencies ==
The Gemfile's dependencies are satisfied
➤ YN0000: · Yarn 4.4.1
➤ YN0000: ┌ Resolution step
➤ YN0000: └ Completed
➤ YN0000: ┌ Post-resolution validation
➤ YN0086: │ Some peer dependencies are incorrectly met by dependencies; run yarn explain peer-requirements for details.
➤ YN0000: └ Completed
➤ YN0000: ┌ Fetch step
➤ YN0000: └ Completed in 0s 278ms
➤ YN0000: ┌ Link step
➤ YN0000: └ Completed
➤ YN0000: · Done with warnings in 0s 559ms

== Copying env file ==

== Preparing database ==
/home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `require': libpq.so.5: cannot open shared object file: No such file or directory - /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/pg-1.5.8/lib/pg_ext.so (LoadError)
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `block (2 levels) in replace_require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/bootsnap-1.18.4/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:30:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/zeitwerk-2.6.18/lib/zeitwerk/kernel.rb:34:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/pg-1.5.8/lib/pg.rb:49:in `block in <module:PG>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/pg-1.5.8/lib/pg.rb:37:in `block in <module:PG>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/pg-1.5.8/lib/pg.rb:42:in `<module:PG>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/pg-1.5.8/lib/pg.rb:6:in `<main>'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:37:in `require'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:37:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `block (2 levels) in replace_require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/zeitwerk-2.6.18/lib/zeitwerk/kernel.rb:34:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler/runtime.rb:60:in `block (2 levels) in require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler/runtime.rb:55:in `each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler/runtime.rb:55:in `block in require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler/runtime.rb:44:in `each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler/runtime.rb:44:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/bundler.rb:212:in `require'
	from /home/user/work/git/misc/solectrus/config/application.rb:19:in `<top (required)>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `block (2 levels) in replace_require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:97:in `preload'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:171:in `serve'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:153:in `block in run'
	from <internal:kernel>:187:in `loop'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:147:in `run'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application/boot.rb:25:in `<top (required)>'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:136:in `require'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:136:in `require'
	from -e:1:in `<main>'
bin/setup:8:in `system': Command failed with exit 1: bin/rails (RuntimeError)
	from bin/setup:8:in `system!'
	from bin/setup:32:in `block in <main>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/fileutils.rb:240:in `chdir'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/fileutils.rb:240:in `cd'
	from bin/setup:11:in `<main>'

Ändere ich das Brewfile um postgres anstelle von postgres@16 zu installieren, ändert sich die Fehlermeldung:

== Installing dependencies ==
The Gemfile's dependencies are satisfied
➤ YN0000: · Yarn 4.4.1
➤ YN0000: ┌ Resolution step
➤ YN0000: └ Completed
➤ YN0000: ┌ Post-resolution validation
➤ YN0086: │ Some peer dependencies are incorrectly met by dependencies; run yarn explain peer-requirements for details.
➤ YN0000: └ Completed
➤ YN0000: ┌ Fetch step
➤ YN0000: └ Completed in 0s 281ms
➤ YN0000: ┌ Link step
➤ YN0000: └ Completed
➤ YN0000: · Done with warnings in 0s 565ms

== Copying env file ==

== Preparing database ==
/home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql_adapter.rb:65:in `rescue in new_client': There is an issue connecting to your database with your username/password, username: .

Please check your database configuration to ensure the username/password are valid.
 (ActiveRecord::DatabaseConnectionError)
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql_adapter.rb:57:in `new_client'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql_adapter.rb:982:in `connect'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql_adapter.rb:994:in `reconnect'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:662:in `block in reconnect!'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/concurrency/null_lock.rb:9:in `synchronize'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:661:in `reconnect!'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:763:in `block in verify!'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/concurrency/null_lock.rb:9:in `synchronize'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:754:in `verify!'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:771:in `connect!'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:977:in `block in with_raw_connection'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/concurrency/null_lock.rb:9:in `synchronize'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract_adapter.rb:976:in `with_raw_connection'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql/quoting.rb:128:in `quote_string'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract/quoting.rb:76:in `quote'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql/quoting.rb:122:in `quote'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql/schema_statements.rb:1097:in `quoted_scope'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/postgresql/schema_statements.rb:1074:in `data_source_sql'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activerecord-7.2.1/lib/active_record/connection_adapters/abstract/schema_statements.rb:60:in `table_exists?'
	from /home/user/work/git/misc/solectrus/config/application.rb:85:in `block in <class:Application>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:94:in `block in execute_hook'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:87:in `with_execution_control'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:92:in `execute_hook'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:78:in `block in run_load_hooks'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:77:in `each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/activesupport-7.2.1/lib/active_support/lazy_load_hooks.rb:77:in `run_load_hooks'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/application/finisher.rb:94:in `block in <module:Finisher>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/initializable.rb:32:in `instance_exec'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/initializable.rb:32:in `run'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/initializable.rb:61:in `block in run_initializers'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:231:in `block in tsort_each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:353:in `block (2 levels) in each_strongly_connected_component'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:434:in `each_strongly_connected_component_from'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:352:in `block in each_strongly_connected_component'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:350:in `each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:350:in `call'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:350:in `each_strongly_connected_component'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:229:in `tsort_each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/tsort.rb:208:in `tsort_each'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/initializable.rb:60:in `run_initializers'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/railties-7.2.1/lib/rails/application.rb:435:in `initialize!'
	from /home/user/work/git/misc/solectrus/config/environment.rb:5:in `<main>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/bundled_gems.rb:75:in `block (2 levels) in replace_require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/bootsnap-1.18.4/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:30:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/zeitwerk-2.6.18/lib/zeitwerk/kernel.rb:34:in `require'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:112:in `preload'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:171:in `serve'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:153:in `block in run'
	from <internal:kernel>:187:in `loop'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application.rb:147:in `run'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/gems/3.3.0/gems/spring-4.2.1/lib/spring/application/boot.rb:25:in `<top (required)>'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:136:in `require'
	from <internal:/home/user/.rbenv/versions/3.3.5/lib/ruby/site_ruby/3.3.0/rubygems/core_ext/kernel_require.rb>:136:in `require'
	from -e:1:in `<main>'
bin/setup:8:in `system': Command failed with exit 1: bin/rails (RuntimeError)
	from bin/setup:8:in `system!'
	from bin/setup:32:in `block in <main>'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/fileutils.rb:240:in `chdir'
	from /home/user/.rbenv/versions/3.3.5/lib/ruby/3.3.0/fileutils.rb:240:in `cd'
	from bin/setup:11:in `<main>'

An dieser Stelle stecke ich jetzt fest...

[ledermann]

Ja, da ich selber auf einem Mac arbeite, ist das Einrichten einer Entwicklungsumgebung unter Linux noch nie getestet worden. Ich habe momentan kein Linux auf dem Desktop verfügbar, das werde ich mir bei Gelegenheit mal virtualisieren.

Insofern kann ich erst mal nur allgemeine Tipps geben:

Das Problem ist also zunächst PostgreSQL. Lass am besten das bin/setup zunächst weg und konzentriere dich darauf, ob ein gem install pg funktioniert. pg ist der Ruby-Client für PostgreSQL.

Wenn das mit dem Brewfile nicht funktioniert, kannst du PostgreSQL auch auf anderem Wege installieren. Vielleicht so:
https://stackoverflow.com/questions/3116015/how-to-install-postgresqls-pg-gem-on-ubuntu

Anschließend sollte bundle install klappen und auch bin/rails db:prepare fehlerfrei durchlaufen. Für die Datenbank-Verbindung wird config/database.yml verwendet. Die Umgebungsvariablen DB_USER und DB_PASSWORD sind üblicherweise leer. Dort könntest du auch andere Dinge reinschreiben, wenn du eine PostgreSQL-Instanz benutzen möchtest, die ganz woanders läuft. Denkbare wäre z.B. ein Docker-Container.

[ledermann]

@jbaesner: Mittlerweile kann ich das Problem reproduzieren - auf GitHub Codespaces.

Eine richtige Lösung würde auf DevContainers basieren, eine solche Umstellung möchte ich derzeitig aber nicht vornehmen, da es meinen eigenen Workflow stark tangieren würde.

Ich habe aber ein paar Kleinigkeiten korrigiert, die in deinem Fall helfen könnte:

Insbesondere fehlte libpq im Brewfile, um postgresql@16 installieren zu können.

Falls es weiterhin Username/Password-Probleme mit PostgreSQL geben sollte: In .env.development können spezifische Angaben dazu gemacht werden, z.B. so:

DB_HOST=localhost
DB_USER=my-fancy-user-name
DB_PASSWORD=my-secret-password

[boecks]

Es ist zwar etwas random, aber ich hatte mal die Absicht einen Guide für Windows zu schreiben, was am Ende des Tages in WSL (also auch Linux) laufen würde und auch tat!

Leider hat es meine Freizeit bis jetzt nicht mehr hergegeben, dass ich auch weiteren Code beisteure oder diesen Guide fertig ausformuliere, aber füre die Nachwelt seien meine Notizen hiermit bereitgestellt:

solectrus dev env on windows:

1. use wsl for linux vm on windows pc (in this case ubuntu)
2. go to solectrus repo for initial installation instructions
3. start with installing homebrew or an equivalent for the given OS
4. in local solectrus directory: brew tap puma/puma
5. now: brew bundle
6. start puma-dev and stop it afterwards
7. follow setup guide from https://github.com/puma/puma-dev (inklude CA setup, tld resolve, port binding 80/443)
8. setup dev-tld-resolver according https://github.com/puma/dev-tld-resolver
9. install rbenv https://github.com/rbenv/rbenv brew recommended
10. make sure ruby works
11. make sure your bundler version matches gemfile
12. gem install pg
13. install node.js https://nodejs.org/en/download/package-manager
14. install yarn https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable
15. 


Follow https://gorails.com/setup/windows/11 to setup
on Windows host:
1. Windows Subsystem for Linux (Ubuntu-24.04)
on WSL distribution:
2. ASDF (Version Manager for Ruby and Node.js)
3. Ruby via ASDF
4. Node.js via ASDF
5. YARN via npm
6. git including global username, email and ssh-auth for github
7. Rails via gem
8. libpq-dev for Postgres
9. Optional: native Postgres

To setup Solectrus Dev follow https://github.com/solectrus/solectrus?tab=readme-ov-file#development
1. clone the repo from github
2. cd solectrus
3. brew tap puma/puma
4. brew bundle
5. to setup puma-dev follow https://github.com/puma/puma-dev#linux-support 
5.a. start puma-dev at least once before, this creates the certificates and directories that are used and referenced in the described commands 
5.b. use ´readlink -f /home/linuxbrew/.linuxbrew/bin/puma-dev´ to retrieve the actual path for the described setcap command to allow puma-dev binding to port 80 and 443
6. When using WSL, Windows and the WSL Distro share the same hosts file. To quickly achieve resolving of *.solectrus.test hosts, add each to the Windows hosts file.
6.a. add to C:/Windows/System32/etc/hosts (as admin) 
    127.0.0.1 vite.solectrus.test
    127.0.0.1 registration.solectrus.test
    127.0.0.1 update.solectrus.test
6.b. alternatively: to setup dev-tld-resolve follow https://github.com/puma/dev-tld-resolver#installation (be aware of some issues where Windos cannot resolve what WSL can), also last commit to this Repo was 2020
7. create .env.development.local and .env.test.local environment files to configure you environments.
8. Install docker, follow: https://docs.docker.com/engine/install/ubuntu/ including https://docs.docker.com/engine/install/linux-postinstall/

LG Sascha