gliargovas / applied-software-engineering-assignments

About this repository

This repository contains the implementation of the lab assignments for the 2021 Applied Software Engineering course. The repository consists of the following:

• The grade histogram module, which is used for generating a histogram with student grades from a file.
• The unit testing module, which is about getting familiar with JUnit.
• The source code analyzer module, which is about getting familiar with SOLID design principles and software design patterns.

Technologies and tools

• Java: Java JDK 1.8 is being used for the purposes of the assignments. You can download the latest version here.

• Maven: The latest version of Apache Maven is also being used for building the project. You can find instructions on how to download, install and run Maven here.

• JUnit 4: Unit testing tool JUnit is being used in unittesting module.

• Travis CI: Travis CI is being used for continuous integration of the project.

Building and running the project

Cloning the repository

In order to build and run the project,

• To clone the repository, run the following command on your terminal:

  git clone https://github.com/gliargovas/applied-software-engineering-assignments.git

Note: you must have installed Git in your local machine. You can alternatively download the project in a zipped format or import the project via your preferred IDE.

Building and running directly from the command line

In order to build and run the project, you must have Java JDK 1.8 installed and configured on your local machine. Additionally, you will need Apache Maven for building the project.

• To build the project and generate the executable jar files of each module, run:

  mvn package

You must see the execution messages of Maven along with a BUILD SUCCESS message at the end of the process. A target directory, containing the executable fat jar file will be generated for each module.

Running histogram generator

In order to generate a histogram from a grade file using histogram generator, from the project's main directory, run:

java -jar .\gradehistogram\target\gradehistogram-1.0-SNAPSHOT-jar-with-dependencies.jar <FILE_PATH>

where <FILE_PATH> the relative or absolute path to the grades file.

applied-software-engineering-assignments's Issues

Redundant method

There is no need to have two readFile methods; you can simply modify the existing one. In a real project, would you create two methods for the same functionality?

Untested normal/border/zero/exception cases

You have not tested all normal/border/zero/exception cases of methods. Please enrich your unit tests. The code coverage reports should guide you as well.

Also please make sure you test printed messages as well.

Incomplete README file

Be as detailed as possible. Please complete:

• the purpose of this repository,
• technologies and tools used and required to build the project,
• how to build and run the project.

Unhandled exception in ArithmeticOperations class

The purpose of unit testing is to test your code for faults and unexpected behavior, and then correct and improve your code based on the unit testing results.

Please have a look again at the multiply method to find a particular case that has escaped you, and amend it with the appropriate code modifications and unit tests.

Missing License file

Please define your license (MIT is enough for the assignments).

Missing or Improper use of Maven project names

Use meaningful names and descriptions for Maven projects and directories in your repository.
Consider that the parent project will contain all future assignments, not only the second one.