A simple web-application which allows the user to conduct some analysis of an html web page. It provides a simple interface where user can enter a html page url and submit. The application processes the given html url and returns the results of analysis in a simple tabular fashion.
Follow the instructions below to setup and build the project in our local machine.
This project is build using the below tools. Please ensure you have the below prerequisites satisfied
1. JDK 1.8 or above
2. Gradle 4.1 or above
This project uses the below open source libraries, frameworks and plugins.
1. Spring Boot gradle plug-in 1.5.7.RELEASE
2. Jsoup 1.10.3
3. Guava:23.1-jre
4. Pagination.js 2.0.8
Clone and run the project using below commands.
git clone https://github.com/gouthampradhan/html-analyzer.git
If you are using a IDE for example Intellij then, import project and choose build.gradle file. For more information you can check out the link https://spring.io/guides/gs/intellij-idea/
Use the below command to run automated test suite
./gradlew test
Use the below command to build the project and run from the project root directory. The project will build and run in a embedded tomcat instance.
./gradlew bootRun
If the build is successful then you should see something like this in the console
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v1.5.7.RELEASE)
2017-10-09 20:39:14.172 INFO 73274 --- [ main] htmlanalyzer.Application : No active profile set, falling back to default profiles: default
2017-10-09 20:39:14.358 INFO 73274 --- [ main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@2c1b194a: startup date [Mon Oct 09 20:39:14 CEST 2017]; root of context hierarchy
2017-10-09 20:39:16.678 INFO 73274 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat initialized with port(s): 8080 (http)
2017-10-09 20:39:16.706 INFO 73274 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2017-10-09 20:39:16.708 INFO 73274 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/8.5.20
2017-10-09 20:39:16.972 INFO 73274 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2017-10-09 20:39:16.972 INFO 73274 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 2644 ms
2017-10-09 20:39:17.161 INFO 73274 --- [ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2017-10-09 20:39:17.172 INFO 73274 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'characterEncodingFilter' to: [/*]
2017-10-09 20:39:17.173 INFO 73274 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
2017-10-09 20:39:17.173 INFO 73274 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'httpPutFormContentFilter' to: [/*]
2017-10-09 20:39:17.173 INFO 73274 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean : Mapping filter: 'requestContextFilter' to: [/*]
2017-10-09 20:39:17.729 INFO 73274 --- [ main] s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@2c1b194a: startup date [Mon Oct 09 20:39:14 CEST 2017]; root of context hierarchy
2017-10-09 20:39:17.855 INFO 73274 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/rest/metadata]}" onto public htmlanalyzer.rest.model.MetaData htmlanalyzer.rest.service.HTMLAnalyzeController.metadata(java.lang.String)
2017-10-09 20:39:17.857 INFO 73274 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/rest/links]}" onto public htmlanalyzer.rest.model.Links<htmlanalyzer.rest.model.Link> htmlanalyzer.rest.service.HTMLAnalyzeController.links(java.lang.String,int,int)
2017-10-09 20:39:17.860 INFO 73274 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2017-10-09 20:39:17.861 INFO 73274 --- [ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2017-10-09 20:39:17.914 INFO 73274 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-10-09 20:39:17.915 INFO 73274 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-10-09 20:39:18.022 INFO 73274 --- [ main] o.s.w.s.handler.SimpleUrlHandlerMapping : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2017-10-09 20:39:18.119 INFO 73274 --- [ main] oConfiguration$WelcomePageHandlerMapping : Adding welcome page: class path resource [static/index.html]
2017-10-09 20:39:18.593 INFO 73274 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
2017-10-09 20:39:18.747 INFO 73274 --- [ main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
2017-10-09 20:39:18.756 INFO 73274 --- [ main] htmlanalyzer.Application : Started Application in 5.63 seconds (JVM running for 7.174)
To check and ensure everything works as expected, open a browser window and hit the below url.
http://localhost:8080
You should see a page with a text box prompting for url to be entered. Enter the URL
and click 'Analyze' as shown below.
The results are shown in a simple tabular fashion which includes below items
-
HTML Version
-
Page title
-
If the page has a login form or not
-
Total number of different heading types
-
Total number of links categorized as internal and external links. Internal links are the links which contain the same domain as the url queried for and external links are ones which are pointing to a different domain.
-
Paginated information containing different links and if the links are reachable and a simple status message. For example, showing information on what went wrong (error message or http status code) while trying to access the link.
