63 lines
2.3 KiB
Markdown
63 lines
2.3 KiB
Markdown
# Development and testing
|
|
|
|
Ensure you have a [Rust toolchain](https://www.rust-lang.org/tools/install) installed.
|
|
|
|
In order to set up a test instance of MariaDB in a docker container, run the following command:
|
|
|
|
```bash
|
|
docker run --rm --name mariadb -e MYSQL_ROOT_PASSWORD=secret -p 3306:3306 -d mariadb:latest
|
|
```
|
|
|
|
This will start a MariaDB instance with the root password `secret`, and expose the port 3306 on the host machine.
|
|
|
|
Run the following command to create a configuration file with the default settings:
|
|
|
|
```bash
|
|
cp ./assets/example-config.toml ./config.toml
|
|
```
|
|
|
|
If you used the docker command above, you can use these settings as is, but if you are running MariaDB/MySQL on another host, port or with another password, adjust the corresponding fields in `config.toml`.
|
|
This file will contain your database password, but is ignored by git, so it will not be committed to the repository.
|
|
|
|
You should now be able to connect to the MariaDB instance, after building the program and using arguments to specify the config file.
|
|
|
|
```bash
|
|
cargo run -- --config-file ./config.toml <args>
|
|
|
|
# example usage
|
|
cargo run -- --config-file ./config.toml create-db "${USER}_testdb"
|
|
cargo run -- --config-file ./config.toml create-user "${USER}_testuser"
|
|
cargo run -- --config-file ./config.toml edit-privs -p "${USER}_testdb:${USER}_testuser:A"
|
|
cargo run -- --config-file ./config.toml show-privs
|
|
```
|
|
|
|
To stop and remove the container, run the following command:
|
|
|
|
```bash
|
|
docker stop mariadb
|
|
```
|
|
|
|
## Development using Nix
|
|
|
|
> [!NOTE]
|
|
> We have created some nix code to generate a QEMU VM with a setup similar to a production deployment
|
|
> There is not necessarily any VMs running in a production setup, and if so then at least not this VM.
|
|
> It is mainly there for easy access to interactive testing, as well as for testing the NixOS module.
|
|
|
|
If you have nix installed, you can easily test your changes in a NixOS test VM by running:
|
|
|
|
```bash
|
|
nix run .#vm # Start a NixOS VM in QEMU with muscl and MariaDB installed
|
|
nix run .#vm-mysql # Start a NixOS VM in QEMU with muscl and MySQL installed
|
|
```
|
|
|
|
You can configure the vm in `flake.nix`
|
|
|
|
## Filter logs by user with journalctl
|
|
|
|
If you want to filter the server logs by user, you can use journalctl's built-in filtering capabilities.
|
|
|
|
```bash
|
|
journalctl -eu muscl F_USER=<username>
|
|
```
|