feat: addind a basic test suite

Author: jagalindo

.github/workflows/test.yml

@@ -0,0 +1,86 @@
+name: Run Grammar Tests
+
+on:
+  push:
+    branches: ['*']
+  pull_request:
+    branches: [develop, main]
+
+jobs:
+  test-javascript:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: js
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+          cache-dependency-path: js/package-lock.json
+
+      - name: Install ANTLR4
+        run: cd .. && make dev
+
+      - name: Build grammar
+        run: npm run build-grammar
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm test
+
+  test-python:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: python
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install ANTLR4
+        run: cd .. && make dev
+
+      - name: Build grammar
+        run: cd .. && make python_parser
+
+      - name: Install dependencies
+        run: |
+          pip install antlr4-python3-runtime==4.13.2
+          pip install -r requirements-dev.txt
+
+      - name: Run tests
+        run: pytest test_grammar.py -v
+
+  test-java:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: java
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Install ANTLR4
+        run: cd .. && make dev
+
+      - name: Cache Maven packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Run tests
+        run: mvn test

.gitignore

@@ -1,21 +1,53 @@
-# VSCode, Eclipse, and IntelliJ IDEA project files
-.vscode
-.settings
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDEs and editors
+.vscode/
+.settings/
 .classpath
 .project
-.idea
+.idea/
+*.iml
+*.swp
+*.swo
+*~
+
+# Java
+target/
+*.class
+*.jar
+*.war
+.antlr/
 
-# Python virtual environments
-env
-build
-python/uvl/__pycache__
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+.venv/
+build/
+dist/
+*.egg-info/
+.eggs/
+.pytest_cache/
+.coverage
+htmlcov/
 python/uvl/*
 !python/uvl/UVLCustomLexer.py
 
-# Node.js
-js/node_modules
+# JavaScript
+node_modules/
+js/node_modules/
 js/package-lock.json
+js/src/lib/
+*.log
+npm-debug.log*
 
-# Java build files
-.antlr/
-target/
+# Environment files
+.env
+.env.local
+.env.*.local

java/pom.xml

@@ -69,6 +69,12 @@
             <artifactId>antlr4-runtime</artifactId>
             <version>${antlr4.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.10.2</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <distributionManagement>
@@ -202,6 +208,12 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.2.5</version>
+            </plugin>
         </plugins>
     </build>
 

java/src/test/java/uvl/ThrowingErrorListener.java

@@ -0,0 +1,16 @@
+package uvl;
+
+import org.antlr.v4.runtime.BaseErrorListener;
+import org.antlr.v4.runtime.RecognitionException;
+import org.antlr.v4.runtime.Recognizer;
+
+public class ThrowingErrorListener extends BaseErrorListener {
+    public static final ThrowingErrorListener INSTANCE = new ThrowingErrorListener();
+
+    @Override
+    public void syntaxError(Recognizer<?, ?> recognizer, Object offendingSymbol,
+                            int line, int charPositionInLine, String msg,
+                            RecognitionException e) {
+        throw new RuntimeException("Line " + line + ":" + charPositionInLine + " " + msg);
+    }
+}

java/src/test/java/uvl/UVLParserTest.java

@@ -0,0 +1,56 @@
+package uvl;
+
+import org.antlr.v4.runtime.CharStream;
+import org.antlr.v4.runtime.CharStreams;
+import org.antlr.v4.runtime.CommonTokenStream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.stream.Stream;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+class UVLParserTest {
+
+    private static final Path TEST_MODELS_DIR = Paths.get("../test_models");
+
+    static Stream<Path> validModels() throws IOException {
+        return Files.walk(TEST_MODELS_DIR)
+                .filter(p -> p.toString().endsWith(".uvl"))
+                .filter(p -> !p.toString().contains("faulty"));
+    }
+
+    static Stream<Path> faultyModels() throws IOException {
+        return Files.list(TEST_MODELS_DIR.resolve("faulty"))
+                .filter(p -> p.toString().endsWith(".uvl"));
+    }
+
+    private void parseFile(Path file) throws IOException {
+        CharStream input = CharStreams.fromPath(file);
+        UVLJavaLexer lexer = new UVLJavaLexer(input);
+        lexer.removeErrorListeners();
+        lexer.addErrorListener(ThrowingErrorListener.INSTANCE);
+        CommonTokenStream tokens = new CommonTokenStream(lexer);
+        UVLJavaParser parser = new UVLJavaParser(tokens);
+        parser.removeErrorListeners();
+        parser.addErrorListener(ThrowingErrorListener.INSTANCE);
+        parser.featureModel();
+    }
+
+    @ParameterizedTest(name = "{0}")
+    @MethodSource("validModels")
+    void testValidModel(Path file) {
+        assertDoesNotThrow(() -> parseFile(file), "Failed to parse: " + file);
+    }
+
+    @ParameterizedTest(name = "{0}")
+    @MethodSource("faultyModels")
+    void testFaultyModel(Path file) {
+        assertThrows(RuntimeException.class, () -> parseFile(file), "Expected parse error for: " + file);
+    }
+}

js/package.json

@@ -12,6 +12,7 @@
     "@eslint/js": "^9.8.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "eslint": "^9.8.0",
+    "glob": "^10.3.10",
     "globals": "^15.8.0",
     "vitest": "^2.0.4"
   },

js/test/grammar.test.js

@@ -0,0 +1,27 @@
+import { expect, describe, test } from 'vitest';
+import { FeatureModel } from "../index.js";
+import { glob } from 'glob';
+import path from 'path';
+
+const TEST_MODELS_DIR = path.resolve(import.meta.dirname, '../../test_models');
+
+const validFiles = glob.sync(`${TEST_MODELS_DIR}/**/*.uvl`, { ignore: '**/faulty/**' });
+const faultyFiles = glob.sync(`${TEST_MODELS_DIR}/faulty/*.uvl`);
+
+describe('Valid UVL models', () => {
+  validFiles.forEach(file => {
+    const relativePath = path.relative(TEST_MODELS_DIR, file);
+    test(`parses ${relativePath}`, () => {
+      expect(() => new FeatureModel(file)).not.toThrow();
+    });
+  });
+});
+
+describe('Faulty UVL models', () => {
+  faultyFiles.forEach(file => {
+    const relativePath = path.relative(TEST_MODELS_DIR, file);
+    test(`rejects ${relativePath}`, () => {
+      expect(() => new FeatureModel(file)).toThrow();
+    });
+  });
+});

python/requirements-dev.txt

@@ -0,0 +1 @@
+pytest>=7.0.0

python/test_grammar.py

@@ -0,0 +1,32 @@
+import pytest
+import glob
+import os
+
+from main import get_tree
+
+TEST_MODELS_DIR = os.path.join(os.path.dirname(__file__), "..", "test_models")
+
+
+def get_valid_files():
+    all_files = glob.glob(os.path.join(TEST_MODELS_DIR, "**", "*.uvl"), recursive=True)
+    return [f for f in all_files if os.sep + "faulty" + os.sep not in f]
+
+
+def get_faulty_files():
+    return glob.glob(os.path.join(TEST_MODELS_DIR, "faulty", "*.uvl"))
+
+
+def relative_path(file):
+    return os.path.relpath(file, TEST_MODELS_DIR)
+
+
+@pytest.mark.parametrize("uvl_file", get_valid_files(), ids=relative_path)
+def test_valid_model(uvl_file):
+    tree = get_tree(uvl_file)
+    assert tree is not None
+
+
+@pytest.mark.parametrize("uvl_file", get_faulty_files(), ids=relative_path)
+def test_faulty_model(uvl_file):
+    with pytest.raises(Exception):
+        get_tree(uvl_file)

test_models/arithmetic_level/aggregate_functions/aggregate.uvl

@@ -0,0 +1,9 @@
+features
+    A {Price 1}
+        optional
+            B {Price 2}
+            C {Price 5}
+
+constraints
+    sum(Price) > 2
+    avg(Price) > 1