- 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>
Closes: Debian #1144740.
- When one of the applications such as bepasty, radicale, or searx need it, then
install it.
- Reduces the number of dependencies for freedombox package.
- Reduces size of the disk image.
- Ensures that uwsgi does not run on every freedombox machine.
- Apache's proxy_uwsgi module (provided by apache2-bin, apache2) can still be
enabled by default because uwsgi is not a dependency for the Apache module and
uwsgi socket connections are not attempted until specific configuration is
enabled and requests arrive.
- Change dependency from uwsgi-core to uwsgi. uwsgi-core does not have init
scripts but uwsgi package has init script (but only on trixie and not forky and
up). The init script is disabled and masked by bepasty, radicale, and searx
apps. So, this should not be a problem.
Tests:
- On a freshly installed Debian forky and trixie machines, install freedombox
deb package built with changes. Installation succeeds. uwsgi is not installed at
all. bepasty and radicale can be installed and basic requests to web UI work.
uwsgi init script is not started and is masked.
- Functional tests for bepasty and radicale work.
- On a Trixie machine, setup freedombox from trixie. Then install freedombox deb
package with the patch. uwsgi is not marked as manually installed and running
unattended-updates will remove it. Install bepasty and uwsgi package is
installed and marked as manually installed.
- On a Trixie machine, setup freedombox from trixie. Install the bepasty app.
Then install freedombox deb package with the patch. uwsgi is marked as manually
installed and running unattended-updates will not remove it.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Tests:
- On Coturn app page, clicking on a tag redirects to Add New App page with tag
filter set to clicked tag.
- On Names app page, clicking on a tag redirects to system page with tag filter
set to clicked tag.
- On Operations page such as when installing an app, clicking on a tag redirects
to Add New App page with tag filter set to clicked tag.
- On Index page such when OpenVPN is clicked description for OpenVPN is shown.
Clicking on a tag in the description redirects to Add New App page with tag
filter set to clicked tag.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Instead of the apps page which will be empty on first boot.
Tests:
- On Next Steps page, click on apps link takes users to add apps page and not
apps page.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- It avoids confusion with two separate app sections in a single page. The
sections/pages can be better titled.
- In future, we can style the apps page (with more status display) differently
from apps-add page (with more search and featured apps).
- Move page specific parts into individual pages instead of in the common
template cards.html.
- Add special message when there are no apps enabled and when there are no more
apps to enable.
- Drop show_disabled flag in cards template that is not needed anymore.
Tests:
- Unit tests work.
- Functional tests work on bepasty when starting with uninstalled, disabled, or
enabled states.
- Apps page shows special message when there are no apps enabled. It is
centered.
- Apps page shows 'Add new app' button with icon. Clicking it takes us to
apps-add page.
- Apps page does not have disabled apps list (even hidden).
- Disabled and uninstalled apps are not shown on apps page.
- Apps-add page shows special message when there are no more apps to be
installed or enabled (test by altering view code to have empty list of apps).
- Apps-add page shows list of apps that are disabled or uninstalled but not
enabled apps. It shows a title 'Add New App'.
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
- Change the IPv6 checkbox into an option to select from IPv4 only, IPv6 only,
or IPv4 and IPv6. Update functional tests.
- Add type hints everywhere.
- Separate out the generic URL update method to its own module. Add unit tests.
- Migrate old configuration to new configuration on first read.
- Store multiple IP addresses in the status. Support showing old status format
of single IP address as well. Show multiple IP addresses in the status table.
- Handle errors during update using exceptions for clearer code.
- For generic URL based updates, capture return code, stdout and stdin in error
message.
Tests:
- Adding a new GnuDIP domain leads to configuration setting ip_type = ipv4
- When adding a new dynamic domain, when generic option is selected IP Address
Type is shown. When GnuDIP is selected, the field is hidden.
- IP Address Type field is as expected. Options and description are as expected.
- When a new domain is added for generic domain, the value of ip_type is set as
expected. Changing the value to other values works. Configuration is updated
as expected. Option values and description are as expected.
- The column for IP Address is now 'IP Addresses'. When multiple IP addresses
are present in the status, they are shown in multiple lines in the tables as
<pre>. When no IP addresses are present, a '-' is shown in the column.
- When generic domain update fails, subprocess failure code, stderr and stdout
are shown in the error message.
- Unit tests work.
- Functional tests work.
- After 5 minute period, attempts are made to update the domain
- For GnuDIP and generic method:
- IP address lookup works for IPv4 and IPv6.
- IP address updates works for IPv4 (tested) and IPv6 (untested).
- In 'both' configuration, when IPv6 update fails, IPv4 still succeeds.
- Updates are skipped if the record is up-to-date.
- Successful updates are performed otherwise.
- Wrong password leads to proper error being shown.
- When the old status is stored, it is updated during read and proper status is
shown.
- When configuration has old use_ipv6 key, then it is migrated when newer
version of the service is started. True value is converted as 'ipv6', False
value is converted as 'ipv4'. 'null' key is properly removed.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
All the users of the old ez-ipupdate client must have been migrated long ago as
the migration code was shipped in bookworm.
Tests:
- Service starts as expected.
- Re-running setup for the app works.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
Explicitly noting down the version of Django helps us keep better track of our
upgrade progress. Due to the nature of changes to Django in recent versions,
FreedomBox does not need any changes to support newer versions. So, work done on
analyzing support for newer versions needs to tracked separate from git log
message.
Tests:
- Building FreedomBox Debian package works.
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
