In this project, our goal is to convert a renowned program analysis tool, Hydrogen, into a web-based platform and present the program analysis results of Hydrogen to the end-users. The interface allows users to upload a few versions of software and select which pairs to analyze. Then, the web interface will display the statistics of MVICFG and visualizations of a certain part of MVICFG based on the location information using an interactive manner. As demonstrated in the paper "Patch verification via multiversion interprocedural control flow graphs, the web-based platform depicts the data collected from constructing MVICFGs such as the number of versions and size of the first version in the benchmarks, the number of program versions, the average number of added and removed statements between any two consecutive versions as churn, time used, and memory overhead, etc.
- Spring Boot has the charge of managing server-side code
- Spotify docker-client has been used to communicate with the docker instance
- Maven used as a build and dependency management tool
- Template engine Thyemleaf used for HTML rendering
- For UI design, Bootstrap and Font-awesome have been used
- Apache Maven(Version: 3.3.9)
- Apache Tomcat (Version: 8)
- JDK (Version: 1.8)
- /src/main/resources/ - contains client-side code
- /src/main/resources/templates/ - contains HTML code
- /src/main/resources/static/ - contains CSS and necessary javascript code
- /src/main/java/com/iastate/web/hydrogen - contains server-side code written in the spring boot framework of Java programming language
- /hydrogen_analysis/user_program - a temporary directory containing files uploaded by the user
- /hydrogen_analysis/hydrogen_output - the result of hydrogen analysis
- /src/main/resources/application.properties - Use this file to configure the application. (Described in next section)
To configure the application, open /src/main/resources/application.properties and modify as follows:
- docker.id: Provide running docker instance ID (You can obtain docker instance ID by running this command in terminal: docker ps)
- hydrogen.path: Path of Hydrogen base path in docker
- file.upload.directory: Location where uploaded files will be stored temporarily
- hydrogen.output.directory: Location where analysis result of Hydrogen will be stored temporarily
- docker.test.directory: A directory created in the docker Hydrogen base path to move uploaded user files
- server.port: The port at which the application will be running
- Go to the root directory of the project
- Open the shell and type the following command: ./mvnw clean package
- Go to the target directory and copy hydrogen-0.0.1-SNAPSHOT.war
- Paste it to any servlet container. For Tomcat, paste it in web apps folder and start Tomcat
- You should be able to access the application in the following URL: http://localhost:9080/hydrogen/
- The landing page provides a prompt to the user to upload a zipped folder containing c files
- Go to the root directory of the project
- Open the shell and type the following command: ./mvnw clean spring-boot:run
- The application will be deployed at default port 9080 (If available).
- If port 9080 is not available, you can run with the port of your choice with command line arguments. For example, to run in port 9070, type: ./mvnw clean spring-boot:run -Drun.arguments="--server.port=9070"
- Create an empty folder.
- Move all c files inside that empty directory.
- Archive the folder. It should have a .zip extension.
- Upload the zipped folder on the website.
- Leveraged MVC software architectural pattern, thereby making it easily extensible, modular, transferable, and scalable.
- Leveraged cutting-edge technologies on every front, easing the potential of incorporating the latest powerful features in the application.