Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions app/Entities/Models/Book.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ public function directPages(): HasMany
*/
public function chapters(): HasMany
{
return $this->hasMany(Chapter::class)
->where('type', '=', 'chapter');
return $this->hasMany(Chapter::class);
}

/**
Expand Down
7 changes: 4 additions & 3 deletions app/Entities/Models/EntityScope.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ class EntityScope implements Scope
public function apply(Builder $builder, Model $model): void
{
$builder = $builder->where('type', '=', $model->getMorphClass());
$table = $model->getTable();
if ($model instanceof Page) {
$builder->leftJoin('entity_page_data', 'entity_page_data.page_id', '=', 'entities.id');
$builder->leftJoin('entity_page_data', 'entity_page_data.page_id', '=', "{$table}.id");
} else {
$builder->leftJoin('entity_container_data', function (JoinClause $join) use ($model) {
$join->on('entity_container_data.entity_id', '=', 'entities.id')
$builder->leftJoin('entity_container_data', function (JoinClause $join) use ($model, $table) {
$join->on('entity_container_data.entity_id', '=', "{$table}.id")
->where('entity_container_data.entity_type', '=', $model->getMorphClass());
});
}
Expand Down
30 changes: 30 additions & 0 deletions dev/docker/db-testing/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
FROM ubuntu:24.04

# Install additional dependencies
RUN apt-get update && \
apt-get install -y \
git \
wget \
zip \
unzip \
php \
php-bcmath php-curl php-mbstring php-gd php-xml php-zip php-mysql php-ldap \
&& \
rm -rf /var/lib/apt/lists/*

# Take branch as an argument so we can choose which BookStack
# branch to test against
ARG BRANCH=development

# Download BookStack & install PHP deps
RUN mkdir -p /var/www && \
git clone https://github.com/bookstackapp/bookstack.git --branch "$BRANCH" --single-branch /var/www/bookstack && \
cd /var/www/bookstack && \
wget https://raw.githubusercontent.com/composer/getcomposer.org/f3108f64b4e1c1ce6eb462b159956461592b3e3e/web/installer -O - -q | php -- --quiet --filename=composer && \
php composer install

# Set the BookStack dir as the default working dir
WORKDIR /var/www/bookstack

# Set the default action as running php
ENTRYPOINT ["/bin/php"]
57 changes: 57 additions & 0 deletions dev/docker/db-testing/run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
#!/bin/bash

BRANCH=${1:-development}

# Build the container with a known name
docker build --build-arg BRANCH="$BRANCH" -t bookstack:db-testing .
if [ $? -eq 1 ]; then
echo "Failed to build app container for testing"
exit 1
fi

# List of database containers to test against
containers=(
"mysql:5.7"
"mysql:8.0"
"mysql:8.4"
"mysql:9.5"
"mariadb:10.2"
"mariadb:10.6"
"mariadb:10.11"
"mariadb:11.4"
"mariadb:11.8"
"mariadb:12.0"
)

# Pre-clean-up from prior runs
docker stop bs-dbtest-db
docker network rm bs-dbtest-net

# Cycle over each database image
for img in "${containers[@]}"; do
echo "Starting tests with $img..."
docker network create bs-dbtest-net
docker run -d --rm --name "bs-dbtest-db" \
-e MYSQL_DATABASE=bookstack-test \
-e MYSQL_USER=bookstack \
-e MYSQL_PASSWORD=bookstack \
-e MYSQL_ROOT_PASSWORD=password \
--network=bs-dbtest-net \
"$img"
sleep 20
APP_RUN='docker run -it --rm --network=bs-dbtest-net -e TEST_DATABASE_URL="mysql://bookstack:bookstack@bs-dbtest-db:3306" bookstack:db-testing'
$APP_RUN artisan migrate --force --database=mysql_testing
$APP_RUN artisan db:seed --force --class=DummyContentSeeder --database=mysql_testing
$APP_RUN vendor/bin/phpunit
if [ $? -eq 0 ]; then
echo "$img - Success"
else
echo "$img - Error"
read -p "Stop script? [y/N] " ans
[[ $ans == [yY] ]] && exit 0
fi

docker stop "bs-dbtest-db"
docker network rm bs-dbtest-net
done

44 changes: 44 additions & 0 deletions tests/Entity/EntityQueryTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php

namespace Entity;

use BookStack\Entities\Models\Book;
use Illuminate\Database\Eloquent\Builder;
use Tests\TestCase;

class EntityQueryTest extends TestCase
{
public function test_basic_entity_query_has_join_and_type_applied()
{
$query = Book::query();
$expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where `type` = ? and `entities`.`deleted_at` is null';
$this->assertEquals($expected, $query->toSql());
$this->assertEquals(['book', 'book'], $query->getBindings());
}

public function test_joins_in_sub_queries_use_alias_names()
{
$query = Book::query()->whereHas('chapters', function (Builder $query) {
$query->where('name', '=', 'a');
});

// Probably from type limits on relation where not needed?
$expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where exists (select * from `entities` as `laravel_reserved_%d` left join `entity_container_data` on `entity_container_data`.`entity_id` = `laravel_reserved_%d`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`id` = `laravel_reserved_%d`.`book_id` and `name` = ? and `type` = ? and `laravel_reserved_%d`.`deleted_at` is null) and `type` = ? and `entities`.`deleted_at` is null';
$this->assertStringMatchesFormat($expected, $query->toSql());
$this->assertEquals(['book', 'chapter', 'a', 'chapter', 'book'], $query->getBindings());
}

public function test_book_chapter_relation_applies_type_condition()
{
$book = $this->entities->book();
$query = $book->chapters();
$expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`book_id` = ? and `entities`.`book_id` is not null and `type` = ? and `entities`.`deleted_at` is null';
$this->assertEquals($expected, $query->toSql());
$this->assertEquals(['chapter', $book->id, 'chapter'], $query->getBindings());

$query = Book::query()->whereHas('chapters');
$expected = 'select * from `entities` left join `entity_container_data` on `entity_container_data`.`entity_id` = `entities`.`id` and `entity_container_data`.`entity_type` = ? where exists (select * from `entities` as `laravel_reserved_%d` left join `entity_container_data` on `entity_container_data`.`entity_id` = `laravel_reserved_%d`.`id` and `entity_container_data`.`entity_type` = ? where `entities`.`id` = `laravel_reserved_%d`.`book_id` and `type` = ? and `laravel_reserved_%d`.`deleted_at` is null) and `type` = ? and `entities`.`deleted_at` is null';
$this->assertStringMatchesFormat($expected, $query->toSql());
$this->assertEquals(['book', 'chapter', 'chapter', 'book'], $query->getBindings());
}
}
4 changes: 4 additions & 0 deletions tests/Uploads/ImageTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ public function test_image_display_thumbnail_generation_for_apng_images_uses_ori

public function test_image_display_thumbnail_generation_for_animated_avif_images_uses_original_file()
{
if (! function_exists('imageavif')) {
$this->markTestSkipped('imageavif() is not available');
}

$page = $this->entities->page();
$admin = $this->users->admin();
$this->actingAs($admin);
Expand Down