[CI] Move several config files for ci in dedicated folder and add a script to check expectations of test files for pytest

Author: Etienne Maheux

.gitlab-ci.yml

@@ -40,6 +40,15 @@ update_conda_linux:
     - conda
   # leave this job for latter deploy jobs (executed on linux only & using conda)
 
+check_tests:
+  stage: .pre
+  script:
+    - bash "ci/check_tests.sh"
+  tags:
+    - bash  # no matter macos or linux
+  rules:
+    - if: $CI_COMMIT_BRANCH  # job not needed for latter deploy jobs (executed on linux only)
+
 # Base job for jobs looping on Python environment and testing different OS
 .one_for_each_python_version_and_runner_os:
   parallel:
@@ -114,7 +123,7 @@ pages:
   rules:
     - if: $CI_COMMIT_BRANCH # == $CI_DEFAULT_BRANCH
   tags:
-    - bash  # arbitrary choice...
+    - shell  # arbitrary choice...
   dependencies:
     - tests
   script:
@@ -132,7 +141,7 @@ prepare_metadata:
   rules:
     - if: $CI_COMMIT_TAG
   tags:
-    - bash  # arbitrary choice...
+    - shell  # arbitrary choice...
   variables:
     VERSION_PYTHON_FILE: leaspy/__init__.py
     VERSION_REGEX: '^__version__\s*=\s*[\x27"](.+)[\x27"].*$'  # \x27 is for single quote
@@ -196,5 +205,5 @@ releases:
     PKG_VERSION: $PKG_VERSION
     PKG_VERSION_WITHOUT_DEV_SUFFIX: $PKG_VERSION_WITHOUT_DEV_SUFFIX
   trigger:
-    include: .releases.gitlab-ci.yml
+    include: ci/releases.gitlab-ci.yml
     strategy: depend

.mdlrc

@@ -1 +1 @@
-style ".mdlrc.style"
+style "ci/.mdlrc.style"

.mdlrc.style renamed to ci/.mdlrc.style

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+for test_dir in unit_tests functional_tests; do
+	# check no missing __init__.py file
+	nb_init=$(find tests/$test_dir -type f -name "__init__.py" | wc -l)
+	nb_folder=$(find tests/$test_dir -type d -not -name "__*" | wc -l)
+	if (( $nb_init != $nb_folder )); then
+		echo "Missing a '__init__.py' in a test subfolder from $test_dir."
+		exit 1
+	fi
+
+	# check that all tests files begin with test_*
+	files_not_beginning_by_test=$(find tests/$test_dir -name "*.py" -not -name "test_*" -not -name "__init__.py")
+	nb_not_beginning_by_test=$(find tests/$test_dir -name "*.py" -not -name "test_*" -not -name "__init__.py" | wc -l)
+	if (( $nb_not_beginning_by_test != 0 )); then
+		echo "Test files not matching 'test_*.py' in $test_dir: $files_not_beginning_by_test"
+		exit 1
+	fi
+
+	# TODO? check that all tests classes import LeaspyTestCase?
+done
+
+echo "Tests seems OK!"
+exit 0

.pypirc.in renamed to ci/.pypirc.in

@@ -40,7 +40,7 @@ check_env:
     - echo $TAG_WITHOUT_PREFIX
     - echo $PKG_VERSION
     - echo $PKG_VERSION_WITHOUT_DEV_SUFFIX
-    - envsubst < .pypirc.in > .pypirc  # substitute environment variables in template .pypirc
+    - envsubst < ci/.pypirc.in > .pypirc  # substitute environment variables in template .pypirc
     # update all packages in conda deploy env for later steps
     - conda upgrade --all --yes
     - '[[ "$CI_DEBUG" == "1" ]] && conda info || true'