Skip to content

Commit

Permalink
Omstrukturering og forbedring av kvalitetskontroll (#166)
Browse files Browse the repository at this point in the history
* forbedre robusthet og lesbarhet i `tester.sh`
- Legger til konstanter for feilkoder for å forbedre lesbarheten og vedlikeholdbarheten.
- Inkluderer en funksjon for å sjekke om nødvendige verktøy som csvlint og Python3 er installert.
- Legger til en sjekk for å se om databasefilen eksisterer før skriptet kjøres.
- Qvoterer variabler for å gjøre skriptet mer robust mot spesielle tegn i strenger.

* legg til standard `.gitignore`

* alle variabler engelsk `tester.sh`

* stilér `test.py`

* navnbytter for skript

* flytt alle termtabell sjekker til python skript

* autodetekter flere duplikate oversettelser

* fiks detekterte duplikater

* forenkel `standardize_comment`

* bytt til github action

* Hent kode*

* fjern byggemedalje

* CI installer python 3

* mindre forbedringer til kvalitetskontroll
  • Loading branch information
fredrik-bakke authored Oct 5, 2023
1 parent 7e9ca66 commit 76641fe
Show file tree
Hide file tree
Showing 10 changed files with 447 additions and 184 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/qc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ jobs:
python-version: '3.x'

- name: Termtabell kvalitetskontroll
run: bash ./skript/tester.sh
run: bash ./skript/kjor_sjekker.sh
181 changes: 181 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
### Egendefinerte

/csvlint

### VS Code

.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix

### Python

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
13 changes: 0 additions & 13 deletions .travis.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
"tasks": [
{
"label": "test",
"type": "shell",
"type": "process",
"command": "bash",
"args": ["./skript/tester.sh"],
"args": ["./skript/kjor_sjekker.sh"],
"group": {
"kind": "test",
"isDefault": true
Expand Down
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ Denne ordlista er opprettet for å være et hjelpemiddel slik at både studenter
faglig ansatte lettere kan kommunisere om matematikk på norsk. Prosjektet er et
samarbeid mellom NTNU, UiO og UiA og har mottatt støtte fra Språkrådet.

Status på tester:
[![Build Status](https://travis-ci.com/jfremstad/matematisk_ordliste.svg?branch=master)](https://travis-ci.com/jfremstad/matematisk_ordliste)

### Har du innspill?

Ordlistas termbase er under stadig utvikling, og det er ønskelig at flest mulig
Expand Down
39 changes: 39 additions & 0 deletions skript/kjor_sjekker.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#!/bin/bash

DATABASE="./verifiserte_termer.csv"

ERR_DB_NOT_FOUND=1
ERR_PYTHON_NOT_FOUND=2

EXITCODE=0

# Function to check if a command exists
command_exists () {
command -v "$1" >/dev/null 2>&1
}

# Check if database exists
if [[ ! -f "${DATABASE}" ]]; then
echo "FEIL: Databasefilen '${DATABASE}' ikke funnet."
EXITCODE=$((EXITCODE | ERR_DB_NOT_FOUND))
exit ${EXITCODE}
fi

# Validate term table with python script
if command_exists python3; then
python3 ./skript/valider_termtabell.py "${DATABASE}"
# Capture the exit code of the Python script
PYTHON_SCRIPT_EXITCODE=$?
# OR it with the existing EXITCODE
EXITCODE=$((EXITCODE | PYTHON_SCRIPT_EXITCODE))
else
echo "FEIL: Python3 ikke funnet."
EXITCODE=$((EXITCODE | ERR_PYTHON_NOT_FOUND))
fi

# Check if EXITCODE is 0
if [[ ${EXITCODE} -eq 0 ]]; then
echo "Alle sjekker ble gjennomført uten feil."
fi

exit ${EXITCODE}
101 changes: 0 additions & 101 deletions skript/test.py

This file was deleted.

Loading

0 comments on commit 76641fe

Please sign in to comment.