Merge pull request #73 from cse110-fa22-group29/add-crud-e2e-testing

Add crud e2e testing

package.json

@@ -4,7 +4,7 @@
   "type": "module",
   "scripts": {
     "test": "mocha --recursive --require mock-local-storage './{,!(node_modules)/**}/*.test.js'",
-    "lint": "eslint '**/*.js'",
+    "lint": "eslint **/*.js",
     "fix-style": "eslint --fix **/*.js",
     "lintHTML": "htmlhint '**/*.html'",
     "lintCSS": "stylelint '**/*.css'",
@@ -13,11 +13,11 @@
   "devDependencies": {
     "eslint": "^8.27.0",
     "htmlhint": "1.1.4",
+    "http-server": "",
     "mocha": "10",
     "mock-local-storage": "^1.1.23",
+    "puppeteer": "^18.2.1",
     "stylelint": "14.14.1",
-    "stylelint-config-standard": "^29.0.0",
-    "puppeteer": "18",
-    "http-server": ""
+    "stylelint-config-standard": "^29.0.0"
   }
 }

source/assets/scripts/main.e2e.test.js

@@ -1,5 +1,5 @@
 import {strict as assert} from "node:assert";
-import {describe, it, beforeEach, afterEach} from "mocha";
+import {describe, it, before, after} from "mocha";
 import puppeteer from "puppeteer-core";
 import { exit } from "node:process";
 
@@ -8,23 +8,376 @@ describe("test App end to end", async () => {
 	let browser;
 	let page;
 
-	beforeEach(async () => {
-		browser = await puppeteer.launch();
+	before(async () => {
+		let root;
+		try {
+			root =  process.getuid() == 0;
+		}
+		catch (error) {
+			root = false;
+		}
+
+		browser = await puppeteer.launch({args: root ? ['--no-sandbox'] : undefined});
 		page = await browser.newPage();
 		try{
 			await page.goto("http://localhost:8080", {timeout: 1000});
+			await console.log(`✔ connected to localhost webserver as ${root ? "root" : "user"}`);
 		}
 		catch (error) {
-			console.log("❌ failed to connect to localhost webserver on port 8080");
-			exit(1);
+			await console.log("❌ failed to connect to localhost webserver on port 8080");
+			await exit(1);
 		}
 	});
 
-	it("page should have correct title", async () => {
-		assert.strictEqual(await page.title(), "Food Journal");
+	describe("test simple properties", async () => {
+		it("page should have correct title", async () => {
+			assert.strictEqual(await page.title(), "Food Journal");
+		});
 	});
 
-	afterEach(async () => {
+	describe("test create 1 new review", async () => {
+		it("create 1 new review", async () => {
+			// Click the button to show update form
+			let create_btn = await page.$("#create-btn");
+			await create_btn.click();
+			await page.waitForNavigation();
+
+			// Set text fields
+			await page.$eval("#mealImg", el => el.value = "sample src");
+			await page.$eval("#imgAlt", el => el.value = "sample alt");
+			await page.$eval("#mealName", el => el.value = "sample name");
+			await page.$eval("#comments", el => el.value = "sample comment");
+			await page.$eval("#restaurant", el => el.value = "sample restaurant");
+
+			// Get the button needed to add new tags
+			let tag_btn = await page.$("#tag-add-btn");
+			for(let i = 0; i < 5; i++){
+				await page.$eval("#tag-form", (el, value) => el.value = `tag ${value}`, i);
+				await tag_btn.click();
+			}
+			
+			// Select a new rating of 1 star
+			let rating_select = await page.$("#s1");
+			rating_select.click();
+
+			// Click the save button to save updates
+			let save_btn = await page.$("#save-btn");
+			save_btn.click();
+			await page.waitForNavigation();
+		});
+
+		it("check details page", async () => {
+			// Get the review image and check src and alt
+			let img = await page.$("#d-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "sample src");
+			assert.strictEqual(await imgAlt.jsonValue(), "sample alt");
+
+			// Get the title, comment, and restaurant
+			let title = await page.$("#d-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await page.$("#d-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await page.$("#d-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "sample name");
+			assert.strictEqual(await comment_text.jsonValue(), "sample comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "sample restaurant");
+
+			// Check tags
+			let tags = page.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await page.$("#d-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/5-star.svg");
+		});
+	
+		it("check home page", async () => {
+			// Click the button to return to the home page
+			let home_btn = await page.$("#home-btn");
+			home_btn.click();
+			await page.waitForNavigation();
+
+			// Get the review card again and get its shadowRoot
+			let review_card = await page.$("review-card");
+			let shadowRoot = await review_card.getProperty("shadowRoot");
+
+			// Get the review image and check src and alt
+			let img = await shadowRoot.$("#a-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "sample src");
+			assert.strictEqual(await imgAlt.jsonValue(), "sample alt");
+
+			// Get the title, comment, and restaurant
+			let title = await shadowRoot.$("#a-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await shadowRoot.$("#a-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await shadowRoot.$("#a-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "sample name");
+			assert.strictEqual(await comment_text.jsonValue(), "sample comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "sample restaurant");
+			
+			// Check tags
+			let tags = shadowRoot.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await shadowRoot.$("#a-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/5-star.svg");
+		});
+	});
+
+	describe("test read 1 review after refresh", async () => {
+		it("refresh page", async () => {
+			// Reload the page
+			await page.reload({ waitUntil: ["networkidle0", "domcontentloaded"] });
+		});
+
+		it("check details page", async () => {
+			// click review card
+			let review_card = await page.$("review-card");
+			console.log(JSON.stringify(review_card));
+			await review_card.click();
+			await page.waitForNavigation();
+
+			// Get the review image and check src and alt
+			let img = await page.$("#d-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "sample src");
+			assert.strictEqual(await imgAlt.jsonValue(), "sample alt");
+
+			// Get the title, comment, and restaurant
+			let title = await page.$("#d-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await page.$("#d-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await page.$("#d-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "sample name");
+			assert.strictEqual(await comment_text.jsonValue(), "sample comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "sample restaurant");
+
+			// Check tags
+			let tags = page.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await page.$("#d-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/5-star.svg");
+		});
+
+		it("check home page", async () => {
+			// Click the button to return to the home page
+			let home_btn = await page.$("#home-btn");
+			home_btn.click();
+			await page.waitForNavigation();
+
+			// Get the review card again and get its shadowRoot
+			let review_card = await page.$("review-card");
+			let shadowRoot = await review_card.getProperty("shadowRoot");
+
+			// Get the review image and check src and alt
+			let img = await shadowRoot.$("#a-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "sample src");
+			assert.strictEqual(await imgAlt.jsonValue(), "sample alt");
+
+			// Get the title, comment, and restaurant
+			let title = await shadowRoot.$("#a-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await shadowRoot.$("#a-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await shadowRoot.$("#a-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "sample name");
+			assert.strictEqual(await comment_text.jsonValue(), "sample comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "sample restaurant");
+			
+			// Check tags
+			let tags = shadowRoot.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await shadowRoot.$("#a-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/5-star.svg");
+		});
+	});
+
+	describe("test update 1 review", async () => {
+
+		it("update 1 review", async () => {
+
+			// Get the only review card and click it
+			let review_card = await page.$("review-card");
+			console.log(JSON.stringify(review_card));
+			await review_card.click();
+			await page.waitForNavigation();
+
+			// Click the button to show update form
+			let update_btn = await page.$("#update-btn");
+			await update_btn.click();
+
+			// Set text fields
+			await page.$eval("#mealImg", el => el.value = "updated src");
+			await page.$eval("#imgAlt", el => el.value = "updated alt");
+			await page.$eval("#mealName", el => el.value = "updated name");
+			await page.$eval("#comments", el => el.value = "updated comment");
+			await page.$eval("#restaurant", el => el.value = "updated restaurant");
+
+			// Get all tag elements and click them to delete them
+			let tag_items = await page.$$(".tag");
+			for(let i = 0; i < tag_items.length; i++){
+				await tag_items.click();
+			}
+
+			// Get the button needed to add new tags
+			let tag_btn = await page.$("#tag-add-btn");
+			for(let i = 0; i < 5; i++){
+				await page.$eval("#tag-form", (el, value) => el.value = `updated tag -${value}`, i);
+				await tag_btn.click();
+			}
+			
+			// Select a new rating of 5 stars
+			let rating_select = await page.$("#s5");
+			rating_select.click();
+
+			// Click the save button to save updates
+			let save_btn = await page.$("#save-btn");
+			save_btn.click();
+			await page.waitForNavigation();
+		});
+
+		it("check details page", async () => {
+			// Get the review image and check src and alt
+			let img = await page.$("#d-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "updated src");
+			assert.strictEqual(await imgAlt.jsonValue(), "updated alt");
+
+			// Get the title, comment, and restaurant
+			let title = await page.$("#d-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await page.$("#d-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await page.$("#d-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "updated name");
+			assert.strictEqual(await comment_text.jsonValue(), "updated comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "updated restaurant");
+			
+			// Check tags
+			let tags = page.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `updated tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await page.$("#d-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/1-star.svg");
+		});
+
+		it("check home page", async () => {
+			// Click the button to return to the home page
+			let home_btn = await page.$("#home-btn");
+			home_btn.click();
+			await page.waitForNavigation();
+
+			// Get the review card again and get its shadowRoot
+			let review_card = await page.$("review-card");
+			let shadowRoot = await review_card.getProperty("shadowRoot");
+
+			// Get the review image and check src and alt
+			let img = await shadowRoot.$("#a-mealImg");
+			let imgSrc = await img.getProperty("src");
+			let imgAlt = await img.getProperty("alt");
+			// Check src and alt
+			assert.strictEqual(await imgSrc.jsonValue(), "updated src");
+			assert.strictEqual(await imgAlt.jsonValue(), "updated alt");
+
+			// Get the title, comment, and restaurant
+			let title = await shadowRoot.$("#a-mealName");
+			let title_text = await title.getProperty("innerText");
+			let comment = await shadowRoot.$("#a-comments");
+			let comment_text = await comment.getProperty("innerText");
+			let restaurant = await shadowRoot.$("#a-restaurant");
+			let restaurant_text = await restaurant.getProperty("innerText");
+			// Check title, comment, and restaurant
+			assert.strictEqual(await title_text.jsonValue(), "updated name");
+			assert.strictEqual(await comment_text.jsonValue(), "updated comment");
+			assert.strictEqual(await restaurant_text.jsonValue(), "updated restaurant");
+			
+			// Check tags
+			let tags = shadowRoot.$(".tag");
+			for(let i = 0; i < tags.length; i++){
+				let tag_text = await tags[i].getProperty("innerText");
+				assert.strictEqual(await tag_text.jsonValue(), `tag -${i}`);
+			}
+
+			// Check stars
+			let stars = await shadowRoot.$("#a-rating");
+			let stars_src = await stars.getProperty("src");
+			assert.strictEqual(await stars_src.jsonValue(), "./assets/images/icons/1-star.svg");
+		});
+
+	});
+
+	describe("test delete 1 review", () => {
+		it("delete 1 review", async () => {
+			// Get the only review card and click it
+			let review_card = await page.$("review-card");
+			await review_card.click();
+			await page.waitForNavigation();
+
+			// Get the delete button and click it
+			let delete_btn = await page.$("#delete-btn");
+			await delete_btn.click();
+			await page.waitForNavigation();
+
+			// Check that the card was correctly removed (there should be no remaining cards)
+			review_card = await page.$("#review-card");
+			assert.strictEqual(review_card, null);
+		});
+	});
+
+	after(async () => {
 		await page.close();
 		await browser.close();
 	});