Add SEO tests

Author: Matej Jellus

src/Pentest.ts

@@ -1,26 +1,31 @@
 import Security from './security';
 import HTML from './html';
+import SEO from './seo';
 import WordPress from './wordpress';
 import { Result } from './Test';
 
 interface PentestResult {
   security: Result;
   html: Result;
+  seo: Result;
   wordpress: Result;
 }
 
 class Pentest {
   public async run(url: string): Promise<PentestResult> {
     const security = new Security();
     const html = new HTML();
+    const seo = new SEO();
     const wordPress = new WordPress();
     const securityResult = <Result> await security.run({ url });
     const htmlResult = <Result> await html.run({ url });
+    const seoResult = <Result> await seo.run({ url });
     const wordPressResult = <Result> await wordPress.run({ url });
 
     return {
       security: securityResult,
       html: htmlResult,
+      seo: seoResult,
       wordpress: wordPressResult,
     };
   }

src/functions/getHeading.ts

@@ -0,0 +1,13 @@
+import { URL } from 'url';
+import getObject from './getObject';
+
+const getHeading = (result: any): string | string[] => {
+  const titles = getObject(result.html, 'name', 'h1')
+    .map((title: any) => {
+      return title.children[0].data;
+    });
+  
+  return titles.length > 1 ? titles : titles.shift();
+};
+
+export default getHeading;

src/functions/getTitle.ts

@@ -0,0 +1,13 @@
+import { URL } from 'url';
+import getObject from './getObject';
+
+const getTitle = (result: any): string | string[] => {
+  const titles = getObject(result.html, 'name', 'title')
+    .map((title: any) => {
+      return title.children[0].data;
+    });
+  
+  return titles.length > 1 ? titles : titles.shift();
+};
+
+export default getTitle;

src/functions/index.ts

@@ -9,3 +9,5 @@ export { default as getGenerator } from './getGenerator';
 export { default as parseHtml } from './parseHtml';
 export { default as parseSitemap } from './parseSitemap';
 export { default as parseXml } from './parseXml';
+export { default as getTitle } from './getTitle';
+export { default as getHeading } from './getHeading';

src/functions/parseXml.ts

@@ -3,6 +3,10 @@ import parser from 'xml2js';
 export default function(result) {
   return new Promise((resolve, reject) => {
     parser.parseString(result.body, (err, r) => {
+      if (err) {
+        reject(err);
+      }
+      
       resolve(r);
     });
   });

src/index.ts

@@ -48,7 +48,7 @@ program
     const results = await pentest.run(url);
 
     const report = Report.get(config.report.format);
-    report.write([ results.security, results.html, results.wordpress ]);
+    report.write([ results.security, results.html, results.seo, results.wordpress ]);
   });
 
 program

src/seo/Heading.ts

@@ -0,0 +1,49 @@
+import Test, { TestParameters, Result } from '../Test';
+import request from '../request';
+import logger from '../logger';
+import { getHeading, parseHtml } from '../functions';
+
+class Heading extends Test {
+  public name = 'Heading';
+
+  public async test({ url }: TestParameters): Promise<Result> {
+    logger.info(`Starting ${this.constructor.name} test...`);
+
+    const response = await request.get(url);
+    const html = await parseHtml(response);
+    const heading = getHeading(html);
+    const subTests = this.checkHeading(heading);
+
+    return {
+      status: this.getStatus(subTests.map(test => test.status)),
+      title: this.constructor.name,
+      description: '',
+      results: subTests,
+    };
+  }
+
+  private checkHeading(title: string | string[]): Array<Result> {
+    const results = [];
+
+    results.push({
+      status: typeof title !== undefined && title.length > 0 ? 'SUCCESS' : 'WARNING',
+      title: 'H1 tag',
+    });
+
+    results.push({
+      status: Array.isArray(title) ? 'ERROR' : 'SUCCESS',
+      title: 'Duplicate H1 tag',
+      description: `HTML should contain just one title tag.`,
+    });
+
+    results.push({
+      status: title.length <= 60 ? 'SUCCESS' : 'WARNING',
+      title: 'Title length',
+      description: `Title length should be under 60 characters and it is ${title.length}.`,
+    });
+
+    return results;
+  }
+}
+
+export default Heading;

src/seo/Robots.ts

@@ -0,0 +1,21 @@
+import Test, { TestParameters, Result } from '../Test';
+import request from '../request';
+import logger from '../logger';
+
+class Robots extends Test {
+  public name = 'Robots';
+
+  public async test({ url }: TestParameters): Promise<Result> {
+    logger.info(`Starting ${this.constructor.name} test...`);
+
+    const response = await request.get(`${url}/robots.txt`);
+
+    return {
+      status: Math.floor(response.statusCode / 100) === 2 ? 'SUCCESS' : 'WARNING',
+      title: 'Robots.txt',
+      description: '',
+    };
+  }
+}
+
+export default Robots;

src/seo/Sitemap.ts

@@ -0,0 +1,37 @@
+import Test, { TestParameters, Result } from '../Test';
+import request from '../request';
+import logger from '../logger';
+import { parseXml } from '../functions';
+
+class Sitemap extends Test {
+  public name = 'Sitemap';
+
+  public async test({ url }: TestParameters): Promise<Result> {
+    logger.info(`Starting ${this.constructor.name} test...`);
+
+    const robotsResponse = await request.get(`${url}/robots.txt`);
+
+    let sitemapUrl = `${url}/sitemap.xml`;
+
+    if (Math.floor(robotsResponse.statusCode / 100) === 2) {
+      const lines = robotsResponse.body.split(/\r?\n/);
+
+      const sitemap = lines.find(line => line.startsWith('Sitemap'));
+
+      if (typeof sitemap !== 'undefined') {
+        sitemapUrl = sitemap.split(' ')[1];
+      }
+    }
+
+    const response = await request.get(sitemapUrl);
+    const xml = await parseXml(response) as object;
+
+    return {
+      status: 'sitemapindex' in xml || 'urlset' in xml ? 'SUCCESS' : 'WARNING',
+      title: this.constructor.name,
+      description: '',
+    };
+  }
+}
+
+export default Sitemap;

src/seo/Title.ts

@@ -0,0 +1,49 @@
+import Test, { TestParameters, Result } from '../Test';
+import request from '../request';
+import logger from '../logger';
+import { getTitle, parseHtml } from '../functions';
+
+class Title extends Test {
+  public name = 'Title';
+
+  public async test({ url }: TestParameters): Promise<Result> {
+    logger.info(`Starting ${this.constructor.name} test...`);
+
+    const response = await request.get(url);
+    const html = await parseHtml(response);
+    const title = getTitle(html);
+    const subTests = this.checkTitle(title);
+
+    return {
+      status: this.getStatus(subTests.map(test => test.status)),
+      title: this.constructor.name,
+      description: '',
+      results: subTests,
+    };
+  }
+
+  private checkTitle(title: string | string[]): Array<Result> {
+    const results = [];
+
+    results.push({
+      status: typeof title !== undefined && title.length > 0 ? 'SUCCESS' : 'WARNING',
+      title: 'Title tag',
+    });
+
+    results.push({
+      status: Array.isArray(title) ? 'ERROR' : 'SUCCESS',
+      title: 'Duplicate title tag',
+      description: `HTML should contain just one title tag.`,
+    });
+
+    results.push({
+      status: title.length <= 60 ? 'SUCCESS' : 'WARNING',
+      title: 'Title length',
+      description: `Title length should be under 60 characters and it is ${title.length}.`,
+    });
+
+    return results;
+  }
+}
+
+export default Title;