SCANL · xrenegade100 · Aug 14, 2023 · Aug 14, 2023 · Aug 18, 2023 · Aug 18, 2023
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,6 @@
+[run]
+omit =
+	src/apps/*
+	src/rule/*
+	src/model/*
+	*/__init__.py
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,39 @@
+name: 🚀 IDEAL | test / cov
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+      - dev
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build the Docker image
+        run: docker build . -t ideal
+      - name: 🧪 Run Tests in Docker Container
+        run: docker run -t -w /app ideal pytest
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: code-coverage-report
+          path: coverage.json
+
+  cov:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Download a single artifact
+        uses: actions/download-artifact@v3
+      - name: 📤 Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -140,6 +140,13 @@ coverage.xml
 .pytest_cache/
 cover/
 
+# IDEAL Input Files
+IDEAL_Results.csv
+IDEAL_Results.xlsx
+
+# Greet
+.greet
+
 # Translations
 *.mo
 *.pot
@@ -226,3 +233,4 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+coverage.json
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/ProjectSunshine.iml b/.idea/ProjectSunshine.iml
diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.autopep8",
+        "editor.formatOnSave": true
+    }
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,74 @@
+# IDEAL | CONTRIBUTING
+
+## Commits
+
+We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history
+We follow specs described by [Conventional Commits](https://www.conventionalcommits.org/).
+
+The following is taken from https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
+
+### Commit Message Format
+
+Each commit message consists of a `header`, a `body` and a `footer`. The header has a special format that includes a `type` and a `subject`:
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
+
+```
+<type>: <summary>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+### Header
+
+The **header** is mandatory and the **scope** of the header must be omitted if the change is common among the packages, otherwise it's mandatory. Use the summary field to provide a succinct description of the change:
+
+```
+<type>: <short summary>
+  │           │
+  │           └─⫸ Summary in present tense. Not capitalized. No period at the end.
+  │       
+  │       
+  │
+  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
+```
+
+#### Summary
+
+-   use the imperative, present tense: "change" not "changed" nor "changes"
+-   don't capitalize the first letter
+-   no dot (.) at the end
+
+#### Type
+
+Must be one of the following:
+
+-   build: Changes that affect the build system or external dependencies
+-   ci: Changes to our CI configuration files and scripts
+-   docs: Documentation only changes
+-   feat: A new feature
+-   fix: A bug fix
+-   perf: A code change that improves performance
+-   refactor: A code change that neither fixes a bug nor adds a feature
+-   style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+-   test: Adding missing tests or correcting existing tests
+
+### Body
+
+The **body** is mandatory for all commits except for those of type "docs". When the body is present it must be at least 20 characters long and must conform to the Commit Message Body format.
+**Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".**
+Explain the motivation for the change in the commit message body. This commit message should explain why you are making the change. You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.
+
+### Footer
+
+The footer is optional. The footer should contain a [closing reference to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if any. (e.g. Fixes #<issue-number>)
+
+[Samples](https://github.com/angular/angular/commits/master)
+
+## Branches
+
+New branches must follow this format for their names: `<type>/<description>`
+
+-   `type` refer to the one described in the Commits section.
+-   `description` must be a word representing the changes happening in the branch, with less than 10 characters.
diff --git a/Dockerfile b/Dockerfile
@@ -1,26 +1,57 @@
-# syntax=docker/dockerfile:1
-
-FROM python:3.7
-
-MAINTAINER Anthony Peruma "axp6201@rit.edu"
-
-RUN mkdir app
+FROM ubuntu:22.04
+COPY --from=openjdk:8-jre-slim /usr/local/openjdk-8 /usr/local/openjdk-8
+ENV JAVA_HOME /usr/local/openjdk-8
+RUN update-alternatives --install /usr/bin/java java /usr/local/openjdk-8/bin/java 1
+
+# Install dependencies and needed executables
+RUN  apt-get update && apt-get install -y --no-install-recommends \ 
+    software-properties-common gpg gpg-agent git wget unzip \
+    build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev \
+    libsqlite3-dev libreadline-dev libffi-dev \ 
+    libbz2-dev libarchive13 libcurl4-openssl-dev \
+    # install python3.7
+    && add-apt-repository ppa:deadsnakes/ppa \
+    && apt-get install -y python3.7  \
+    # install srcml and stanford tagger
+    && wget --progress=dot:giga http://131.123.42.38/lmcrs/v1.0.0/srcml_1.0.0-1_ubuntu20.04.deb \
+    && wget --progress=dot:giga https://nlp.stanford.edu/software/stanford-tagger-4.2.0.zip \
+    && unzip stanford-tagger-4.2.0.zip -d stanford \
+    && rm stanford-tagger-4.2.0.zip \
+    # install libssl1.1 for srcml
+    && wget --progress=dot:giga http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb \
+    && dpkg -i ./libssl1.1_1.1.1f-1ubuntu2_amd64.deb \
+    && apt update \
+    && apt-get install -y --no-install-recommends libssl1.1 \
+    && dpkg -i ./srcml_1.0.0-1_ubuntu20.04.deb \
+    && apt install -f --no-install-recommends  \
+    && rm srcml_1.0.0-1_ubuntu20.04.deb \
+    # install pip
+    && apt-get install -y python3-pip \
+    && pip install --upgrade pip \
+    && mkdir /app \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# copy source files into container
+COPY test /app/test
+COPY pytest.ini /app/pytest.ini
+COPY src /app/src/
+COPY requirements.txt /app/requirements.txt
+COPY definitions.py /app/definitions.py
 
 WORKDIR /app
 
-RUN mkdir app
-
-WORKDIR /app/app
-
-COPY requirements.txt .
-
-RUN pip3 install -r requirements.txt
-
-COPY src/ .
-
-WORKDIR /app
+# 
+RUN pip --no-cache-dir install -r  requirements.txt \
+    && echo "import nltk" > download_nltk.py \
+    && echo "nltk.download('wordnet')" >> download_nltk.py \
+    && echo "nltk.download('punkt')" >> download_nltk.py \
+    && echo "nltk.download('stopwords')" >> download_nltk.py \
+    && echo "quit()" >> download_nltk.py \
+    && python3 download_nltk.py \ 
+    && rm download_nltk.py
 
-ENV PYTHONPATH /app/
+WORKDIR /app/src/apps/IDEAL/
 
-CMD ["python", "app/main.py"]
+CMD ["/bin/sh", "/app/src/apps/IDEAL/run.sh"]