- When app is installed for the first time, the drop-in configuration file
/etc/apache2/includes/home-assistant-freedombox.conf is not created properly.
This is because app.enable() is not being called and not all components are
enabled (including the drop-in configuration component). Fix this by calling
app.enable() in setup().
- Ensure that apache2 is restarted after the homeassistant app is update to
version 2 from version 1.
Tests:
- On a fresh VM, without the patch, installing HA does not result in working HA
UI. With patch, on a fresh VM. It works.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Without new HTTP configuration mechanism, proper configuration of HA fails.
This is because we don't setup the configuration before starting Home Assistant.
Home Assistant only migrates the old configuration to new configuration format
only on the first run. It also leaves a "repair" message to the user asking them
to remove the 'http' section from the configuration file.
- Write to the internal storage format of HA after verifying the version of the
format. Writing through API is hindered by the lack of an API token (which
apparently can't be obtained pragmatically).
Tests:
- Install without patches. configuration.yml contains http section. Home
Assistant not work as HTTP configuration is not set. Apply patches and restart
the service. The setup is run again. 'http' section in configuration.yml is
removed. /var/lib/home-assistant-freedombox/config/.storage/http contains the
required configuration keys with proper values. Home Assistant works (after
domain selection).
- Install freshly with patches. configuration.yml does not contain 'http'
section. /var/lib/home-assistant-freedombox/config/ contains the necessary
configuration changes. HA works after domain selection.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Tests:
- Enable scheduled backups for root and remote repo. Modify
schedule.py so that backups and cleanup will run every 2
minutes. Log shows compact command is run for both
/var/lib/freedombox/borgbackup and mount location for remote
repo. No errors shown in log.
Closes: #2380
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
Tests:
- On unstable container, the test fails before the patch and passes after.
- On stable, testing, and unstable containers, unit tests pass.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- When waiting after a auto-client-add operation, sometimes, it is not detected
that server connection exists. Then a new server setup is triggered and this
causes a duplicate wireguard server connection created. Fix this by making wait
operations strictly read-only.
- Also add more safety checks during waiting based one of the seen failures.
Tests:
- Functional tests work.
- Auto add client works much more reliably.
[jvalleroy: Update docstring]
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Previous changes introduced a regression where QR codes and configuration
download stopped working. This is because of removal of private key from
session. Fix this.
- Provide the QR code and configuration download inline so that private key does
not have to stored in session.
- Provide separate QR code and configuration for each of the available
endpoints.
- Move the manual parameters into a separate table for each of the endpoints.
Make it look like this is only needed as the last option.
- Immediately add the client when the page is presented instead of additional
step (there is no use input needed).
- Tone down the warnings into simple text.
- Provide additional parameters in the manual configuration parameters tables to
make it easy to configure (based on the parameters configured on the WireGuard
app for Android). Use terminology that is used in app so that the fields can be
mapped easily by the user.
Tests:
- Functional tests work more reliably now.
- Clicking on the 'Add Client Automatically' creates the client successfully. A
new message is shown with client public key. The description looks good.
- Clicking on 'Download config file', 'Show QR code' and 'Show config
parameters' works. Downloaded configuration file works. QR code works too and
fills in expected parameters. Shown manual parameters are correct.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Some changes in the 'New' menu and a new introduction animation broke the
functional tests. Fix this by updating the way elements are searched for in the
interface.
Tests:
- Functional tests for Nextcloud pass.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Rename manual page from plinth.1 to freedombox.1
Tests:
- Running 'make build install' and 'systemctl daemon-reload' and 'systemctl
restart plinth.service' works. Installing new app works.
- Spawning a new stable VM with the changes works. First wizard works.
Installing new app works.
- On a fresh Trixie machine, install freedombox. Then upgrade to a deb with
these changes. The service continues to work. Installing an app also works.
Binary is now /usr/bin/freedombox. /usr/bin/plinth works but it is a symlink to
/usr/bin/freedombox.
- Build a Debian package and install it on Trixie machine with freedombox
package installed. 'man plinth' works. 'man freedombox' works. Manual page
contents shows changes from 'plinth' to 'freedombox'. plinth.1.gz is a symlink
to freedombox.1.gz.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Tests:
- Functional tests run much more reliably. Although there were several failures
still observed due to following reasons:
- Due to FreedomBox service receiving SIGSEGV (presumably during NM DBus
operations).
- Error something like Invalid UTF-8: setting not known during removal of
a client.
- Unknown failures caused by newly added clients not showing up on the page.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- This does not effect the existing flow much but is a problem when waiting for
the public key to show up in list of peers.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- When no domains are configured, and .local domain is filtered out, an
exception is thrown by the auto-add client page.
- Don't filter out .local domain. It is still a valid endpoint for peers to
connect to.
- Instead of showing just one domain, show all the domains as endpoints to
connect to.
- Don't store private key in the session. It is retained for longer than
necessary and also sessions are stored on the disk.
Tests:
- Remove all configured domains from the system and click 'Add Client
Automatically' button. It throws an exception. With the patch, it works.
- The Add Client Automatically page shows all the domains as endpoints.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- When Nextcloud is enabled, /.well-known/{card,cal}dav URLs are taken over by
Nextcloud. So relying on them makes radicale fail. Instead just check for the
web interface to be available.
Tests:
- Enable Nextcloud and run radicale functional tests. Without the patch tests
fail and with the patch, tests succeed.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- When Nextcloud is enabled, it takes over the .well-known URLs. We don't want
the redirect result to be cached resulting in wanted behavior.
Tests:
- curl -k https://192.168.122.87/.well-known/caldav and curl -k
https://192.168.122.87/.well-known/carddav results in 302 Found responses
instead of 301 permanent redirects.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- We write to a file and immediately this file is consumed by the virsh command.
If the file is not flushed, the virsh command will see an empty file.
Tests:
- Without the change, virsh fails with an error message that the definition file
is empty. With the change, the failure goes away.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Migration files have already been renamed from plinth/migrations/*.py to
freedombox/migrations/*.py. When running these migrations, ensure that database
tables are first created with plinth_* names rather than freedombox_*. This is
because we want the database progression path for fresh installations (with not
tables) as well as the old installation (with plinth_ tables) to be the same. To
achieve this, migrations.CreateModel will be provided with db_table=plinth_*
values.
- Ensure if a migration call (plinth, 0001_initial) ran, then the (freedombox,
0001_initial) is not run again. This is achieved by adding replaces = [] in the
newly renamed migration.
- Create a new migration that renames plinth_* tables to freedombox_*.
- Fix an old migration (0003) to use historic model rather than current model.
This ensure that it uses the plinth_ table during migration rather than
freedombox_ table.
Tests:
- Delete the database and start plinth.service with all the patches. Notice that
the database migration (fresh creation) works well. First setup, first wizard,
bepasty app installation, and notifications work as expected. Notice that
django_migrations table contains entries for (plinth,000[1-6]*) as well
as (freedombox,000[1-7]*).
- Delete the database and start plinth.service without the patches. Run first
setup and wizard. Install bepasty. Then apply the patches and restart
plinth.service. Notice that the database migration (renaming of tables) works
well. First setup is already done. First wizard is not shown. bepasty is shown
as installed. Previously shown notifications are retained . Notice that
django_migrations table contains entries for (plinth,000[1-6]*) as well
as (freedombox,000[1-7]*).
- Delete the database and start plinth.service from trixie version. Run first
setup and wizard. Install bepasty. Then apply the patches and restart
plinth.service. Notice that the database migration (renaming of tables) works
well. First setup is already done. First wizard is not shown. bepasty is shown
as installed. Previously shown notifications are retained . Notice that
django_migrations table contains entries for (plinth,000[1-6]*) as well
as (freedombox,000[1-7]*).
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
