diff options
author | Benjamin Brahmer <info@b-brahmer.de> | 2022-05-29 11:25:38 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-29 11:25:38 +0200 |
commit | eca96ad37d89b442ae4e0463ec8f7a5bee3007f1 (patch) | |
tree | 81b9e611ea846b9931016cea3bc9dcaa1c85e4a1 /tests | |
parent | 86e01a91f3b3fa1220adb899fa56b8bd53720d34 (diff) |
Enable API testing (#1699)
Enable API testing with local php server.
This adds many tests for API v1.2, more still possible.
Which increased the quality of news already.
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Diffstat (limited to 'tests')
-rw-r--r-- | tests/api/feeds.bats | 137 | ||||
-rw-r--r-- | tests/api/folders.bats | 89 | ||||
-rw-r--r-- | tests/api/helpers/settings.bash | 4 | ||||
-rw-r--r-- | tests/api/items.bats | 66 | ||||
-rw-r--r-- | tests/command/explore.bats (renamed from tests/integration/explore.bats) | 0 | ||||
-rw-r--r-- | tests/command/feeds.bats (renamed from tests/integration/feeds.bats) | 0 | ||||
-rw-r--r-- | tests/command/folders.bats (renamed from tests/integration/folders.bats) | 0 | ||||
-rw-r--r-- | tests/command/helpers/settings.bash (renamed from tests/integration/helpers/settings.bash) | 0 | ||||
-rw-r--r-- | tests/command/items.bats (renamed from tests/integration/items.bats) | 0 | ||||
-rw-r--r-- | tests/command/opml.bats (renamed from tests/integration/opml.bats) | 0 | ||||
m--------- | tests/test_helper/bats-assert | 0 | ||||
m--------- | tests/test_helper/bats-support | 0 |
12 files changed, 296 insertions, 0 deletions
diff --git a/tests/api/feeds.bats b/tests/api/feeds.bats new file mode 100644 index 000000000..054fd776a --- /dev/null +++ b/tests/api/feeds.bats @@ -0,0 +1,137 @@ +#!/usr/bin/env bats + +setup() { + load "../test_helper/bats-support/load" + load "../test_helper/bats-assert/load" + load "helpers/settings" + + if test -f "tests/api/helpers/settings-override.bash"; then + load "helpers/settings-override" + fi +} + +TESTSUITE="Feeds" + +teardown() { + # delete all feeds + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $ID_LIST; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/feeds/$i + done + + # delete all folders + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/folders | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $ID_LIST; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/folders/$i + done +} + +@test "[$TESTSUITE] Read empty" { + run http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds + + assert_output --partial "\"feeds\":[]" + assert_output --partial "\"starredCount\":0" +} + +@test "[$TESTSUITE] Create new" { + # run is not working here. + output=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED | jq '.feeds | .[0].url') + + # self reference of feed is used here + assert_output '"https://nextcloud.com/feed/"' +} + +@test "[$TESTSUITE] Create new inside folder" { + # create folder and store id + ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + + # run is not working here. + output=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED folderId=$ID | jq '.feeds | .[0].folderId') + + # check if ID matches + assert_output "$ID" +} + +@test "[$TESTSUITE] Delete one" { + ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED | grep -Po '"id":\K([0-9]+)') + + run http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/feeds/$ID + + assert_output "[]" +} + +@test "[$TESTSUITE] Move feed to different folder" { + # create folders and store ids + FIRST_FOLDER_ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + SECCOND_FOLDER_ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + + FEEDID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED folderId=$FIRST_FOLDER_ID | grep -Po '"id":\K([0-9]+)') + + # move feed, returns nothing + http --ignore-stdin -b -a ${user}:${user} PUT ${BASE_URLv1}/feeds/$FEEDID/move folderId=$SECCOND_FOLDER_ID + + # run is not working here. + output=$(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | jq '.feeds | .[0].folderId') + + # look for second folder id + assert_output "$SECCOND_FOLDER_ID" +} + +@test "[$TESTSUITE] Move feed to root" { + # create folder and store id + FOLDER_ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + + FEEDID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED folderId=$FOLDER_ID | grep -Po '"id":\K([0-9]+)') + + # move feed to "null", returns nothing + http --ignore-stdin -b -a ${user}:${user} PUT ${BASE_URLv1}/feeds/$FEEDID/move folderId=null + + # run is not working here. + output=$(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | jq '.feeds | .[0].folderId') + + # new "folder" should be null + assert_output null +} + +@test "[$TESTSUITE] Rename feed" { + # create feed and store id + FEEDID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED | grep -Po '"id":\K([0-9]+)') + + # rename feed, returns nothing + http --ignore-stdin -b -a ${user}:${user} PUT ${BASE_URLv1}/feeds/$FEEDID/rename feedTitle="Great Title" + + # run is not working here. + output=$(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | jq '.feeds | .[0].title') + + # Check if title matches + assert_output '"Great Title"' +} + +@test "[$TESTSUITE] Mark all items as read" { + # create feed and store id + FEEDID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED | grep -Po '"id":\K([0-9]+)') + + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items id=$FEEDID | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + + # get biggest item ID + max=${ID_LIST[0]} + for n in "${ID_LIST[@]}" ; do + ((n > max)) && max=$n + done + + # mark all items of feed as read, returns nothing + STATUS_CODE=$(http --ignore-stdin -hdo /tmp/body -a ${user}:${user} PUT ${BASE_URLv1}/feeds/$FEEDID/read newestItemId="$max" 2>&1| grep HTTP/) + + # collect unread status + unread=$(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items id=$FEEDID | grep -Po '"unread":\K((true)|(false))' | tr '\n' ' ') + + for n in "${unread[@]}" ; do + if $n + then + echo "Item was not marked as read" + echo $STATUS_CODE + false + fi + done +} + diff --git a/tests/api/folders.bats b/tests/api/folders.bats new file mode 100644 index 000000000..710b7d2a3 --- /dev/null +++ b/tests/api/folders.bats @@ -0,0 +1,89 @@ +#!/usr/bin/env bats + +setup() { + load "../test_helper/bats-support/load" + load "../test_helper/bats-assert/load" + load "helpers/settings" + + if test -f "tests/api/helpers/settings-override.bash"; then + load "helpers/settings-override" + fi + +} + +TESTSUITE="Folders" + +teardown() { + # delete all feeds + FEED_IDS=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $FEED_IDS; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/feeds/$i + done + + # delete all folders + FOLDER_IDS=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/folders | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $FOLDER_IDS; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/folders/$i + done +} + +@test "[$TESTSUITE] Read empty" { + run http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/folders + + assert_output --partial "\"folders\":[]" +} + +@test "[$TESTSUITE] Create new" { + run http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} + + assert_output --partial "\"name\":\"news-${BATS_SUITE_TEST_NUMBER}\"," +} + +@test "[$TESTSUITE] Delete folder" { + ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + + run http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/folders/$ID + + assert_output "[]" +} + +@test "[$TESTSUITE] Rename folder" { + ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + + # Rename folder + http --ignore-stdin -b -a ${user}:${user} PUT ${BASE_URLv1}/folders/$ID name=rename-${BATS_SUITE_TEST_NUMBER} + + run http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/folders + + assert_output --partial "\"name\":\"rename-${BATS_SUITE_TEST_NUMBER}\"," +} + +@test "[$TESTSUITE] Mark all items as read" { + # create folder and feed in folder + FOLDER_ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/folders name=news-${BATS_SUITE_TEST_NUMBER} | grep -Po '"id":\K([0-9]+)') + FEED_ID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED folderId=$FOLDER_ID | grep -Po '"id":\K([0-9]+)') + + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items id=$FEEDID | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + + # get biggest item ID + max=${ID_LIST[0]} + for n in "${ID_LIST[@]}" ; do + ((n > max)) && max=$n + done + + # mark all items of feed as read, returns nothing + STATUS_CODE=$(http --ignore-stdin -hdo /tmp/body -a ${user}:${user} PUT ${BASE_URLv1}/folders/$FOLDER_ID/read newestItemId="$max" 2>&1| grep HTTP/) + + # collect unread status + unread=$(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items id=$FEEDID | grep -Po '"unread":\K((true)|(false))' | tr '\n' ' ') + + for n in "${unread[@]}" ; do + if $n + then + echo "Item was not marked as read" + echo $STATUS_CODE + false + fi + done +} + diff --git a/tests/api/helpers/settings.bash b/tests/api/helpers/settings.bash new file mode 100644 index 000000000..3b31fba4c --- /dev/null +++ b/tests/api/helpers/settings.bash @@ -0,0 +1,4 @@ +user=admin +NC_FEED="https://nextcloud.com/blog/static-feed/" +HEISE_FEED="https://www.heise.de/rss/heise-atom.xml" +BASE_URLv1="http://localhost:8080/index.php/apps/news/api/v1-2"
\ No newline at end of file diff --git a/tests/api/items.bats b/tests/api/items.bats new file mode 100644 index 000000000..349678966 --- /dev/null +++ b/tests/api/items.bats @@ -0,0 +1,66 @@ +#!/usr/bin/env bats + +setup() { + load "../test_helper/bats-support/load" + load "../test_helper/bats-assert/load" + load "helpers/settings" + + if test -f "tests/api/helpers/settings-override.bash"; then + load "helpers/settings-override" + fi +} + +TESTSUITE="Items" + +teardown() { + # delete all feeds + FEED_IDS=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/feeds | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $FEED_IDS; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/feeds/$i + done + + # delete all folders + FOLDER_IDS=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/folders | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + for i in $FOLDER_IDS; do + http --ignore-stdin -b -a ${user}:${user} DELETE ${BASE_URLv1}/folders/$i + done +} + +@test "[$TESTSUITE] Read empty" { + run http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items + + assert_output --partial "\"items\":[]" +} + +@test "[$TESTSUITE] Read 5" { + http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED + + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items batchSize=5 | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + + output=${#ID_LIST[@]} + + assert_output --partial "5" +} + +# TODO GET /items has more options that could be tested. + +@test "[$TESTSUITE] Check updated" { + FEEDID=$(http --ignore-stdin -b -a ${user}:${user} POST ${BASE_URLv1}/feeds url=$NC_FEED | grep -Po '"id":\K([0-9]+)') + ID_LIST=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items id=$FEEDID | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + + # get biggest item ID + max=${ID_LIST[0]} + for n in "${ID_LIST[@]}" ; do + ((n > max)) && max=$n + done + + SYNC_TIME=$(date +%s) + + # mark all items of feed as read, returns nothing (other client marks items as read) + STATUS_CODE=$(http --ignore-stdin -hdo /tmp/body -a ${user}:${user} PUT ${BASE_URLv1}/feeds/$FEEDID/read newestItemId="$max" 2>&1| grep HTTP/) + + # client 2 checks for updates since last sync + UPDATED_ITEMS=($(http --ignore-stdin -b -a ${user}:${user} GET ${BASE_URLv1}/items/updated id=$FEEDID lastModified=$SYNC_TIME | grep -Po '"id":\K([0-9]+)' | tr '\n' ' ')) + + assert_equal ${#ID_LIST[@]} ${#UPDATED_ITEMS[@]} +}
\ No newline at end of file diff --git a/tests/integration/explore.bats b/tests/command/explore.bats index 7407dc8a8..7407dc8a8 100644 --- a/tests/integration/explore.bats +++ b/tests/command/explore.bats diff --git a/tests/integration/feeds.bats b/tests/command/feeds.bats index 5ad52dc30..5ad52dc30 100644 --- a/tests/integration/feeds.bats +++ b/tests/command/feeds.bats diff --git a/tests/integration/folders.bats b/tests/command/folders.bats index 48b15f05b..48b15f05b 100644 --- a/tests/integration/folders.bats +++ b/tests/command/folders.bats diff --git a/tests/integration/helpers/settings.bash b/tests/command/helpers/settings.bash index bf58a601a..bf58a601a 100644 --- a/tests/integration/helpers/settings.bash +++ b/tests/command/helpers/settings.bash diff --git a/tests/integration/items.bats b/tests/command/items.bats index 22a4c73c7..22a4c73c7 100644 --- a/tests/integration/items.bats +++ b/tests/command/items.bats diff --git a/tests/integration/opml.bats b/tests/command/opml.bats index b2d576e8e..b2d576e8e 100644 --- a/tests/integration/opml.bats +++ b/tests/command/opml.bats diff --git a/tests/test_helper/bats-assert b/tests/test_helper/bats-assert new file mode 160000 +Subproject 397c735212bf1a06cfdd0cb7806c5a6ea79582b diff --git a/tests/test_helper/bats-support b/tests/test_helper/bats-support new file mode 160000 +Subproject 3c8fadc5097c9acfc96d836dced2bb598e48b00 |