Added to tests and README

ParadigmZero · Jun 14, 2023 · a72d693 · a72d693
1 parent 2d40a62
commit a72d693
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -92,11 +92,27 @@ Run as follows:
 
 `newman run WebpageWordCounter.postman_collection.json`
 
-You can also test the endpoints individually as so:
+Further options:
 
-`newman run WebpageWordCounter.postman_collection.json --folder wordcount`
+- change `base_url` (the default is <http://localhost:4000>). Example:
 
-`newman run WebpageWordCounter.postman_collection.json --folder dynamicwordcount`
+`--env-var "base_url=https://webpagewordcount.onrender.com"`
+
+- test a single endpoint. Endpoints are organized in folders in the collection. Folder names correspond to endpoint names, and so you can specify which endpoint to test as follows:
+
+`--folder dynamicwordcount`
+
+Sample run:
+
+`newman run WebpageWordCounter.postman_collection.json --env-var "base_url=https://webpagewordcount.onrender.com" --folder wordcount`
+
+# Deployment ( as of date of this README publication )
+
+Dockerized application has a free-tier deployment with `Render.com` at the following URL.
+
+<https://webpagewordcount.onrender.com>
+
+The Master branch is automatically deployed there.
 
 # Development related
 

diff --git a/src/index.ts b/src/index.ts
@@ -315,7 +315,7 @@ export function getEmbeddedPageUrls(body : string) : string[] {
  * @param url - string of url
  * @returns the url with http:// appended if necessary
  */
-function addHTTPtoUrl(url : string) : string
+export function addHTTPtoUrl(url : string) : string
 {
   if(url.substring(0,7).toLowerCase() !== 'http://'
     &&
@@ -349,4 +349,4 @@ export function urlResolver(originalUrl : string, newUrl : string) : string {
 }
 
 
-module.exports = {app, openapiSpecification, wordCount, getEmbeddedPageUrls, urlResolver, dynamicWordCount};
+module.exports = {app, wordCount, dynamicWordCount, addHTTPtoUrl, getEmbeddedPageUrls, urlResolver};
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -1,11 +1,17 @@
-import {urlResolver, getEmbeddedPageUrls, wordCount, dynamicWordCount} from "../src/index";
+import {urlResolver, addHTTPtoUrl, getEmbeddedPageUrls, wordCount, dynamicWordCount} from "../src/index";
 
 test("urls are properly resolved (with base url) in the urlResolver method", () => {
     expect(urlResolver("http://www.mydomain.com/","./dir/mypage.html")).toEqual("http://www.mydomain.com/dir/mypage.html");
     expect(urlResolver("http://www.mydomain.com/","mypage.html")).toEqual("http://www.mydomain.com/mypage.html");
     expect(urlResolver("http://www.mydomain.com/","http://www.adifferentsite.com")).toEqual("http://www.adifferentsite.com");
 });
 
+test("Add http:// to urls where appropriate in addHTTPtoUrl method", () => {
+    expect(addHTTPtoUrl("google.com" as string)).toEqual("http://google.com");
+    expect(addHTTPtoUrl("http://google.com" as string)).toEqual("http://google.com");
+    expect(addHTTPtoUrl("https://google.com" as string)).toEqual("https://google.com");
+});
+
 test("The getEmbeddedPageUrls function should extract the url from embedded content tags", () => {
     expect(getEmbeddedPageUrls(`
     <html>