Merge branch 'release/v1.0.2'

Author: Xbluer

.github/workflows/build.yml

@@ -69,7 +69,7 @@ jobs:
             ${{ secrets.DOCKERHUB_USERNAME }}/veritas-assessment-tool:latest
             ${{ secrets.DOCKERHUB_USERNAME }}/veritas-assessment-tool:v1
             ${{ secrets.DOCKERHUB_USERNAME }}/veritas-assessment-tool:v1.0
-            ${{ secrets.DOCKERHUB_USERNAME }}/veritas-assessment-tool:v1.0.1
+            ${{ secrets.DOCKERHUB_USERNAME }}/veritas-assessment-tool:v1.0.2
 
 
       - name: Move cache

bin/install.sh

@@ -5,8 +5,12 @@ cd py || exit
 
 pip3 install virtualenv
 
+if [[ -d venv ]]; then
+  rm -rf venv
+fi
+# create virtual environment
 virtualenv venv -p python3
-
+# using virtual environment
 source venv/bin/activate
-
+# install python module
 pip3 install --no-cache-dir -r requirements.txt

bin/start.sh

@@ -6,4 +6,6 @@ if [[ -f py/venv/bin/activate ]]; then
   source py/venv/bin/activate
 fi
 
-nohup java -jar $(pwd)/jar/veritas-assessment-tool.jar 1>>log/stdout.log 2>&1 &
+JVM_OPT='-Dlog4j2.formatMsgNoLookups=true'
+
+nohup java ${JVM_OPT} -jar $(pwd)/jar/veritas-assessment-tool.jar 1>>log/stdout.log 2>&1 &

bin/tool.sh

@@ -0,0 +1,114 @@
+#!/bin/bash
+
+POSITIONAL=()
+
+
+function check_user() {
+  local l_user="$1"
+  local l_user_count=`sqlite3 $SQLITE_FILE <<EOF
+  select count(id) from vat_user where username = "$l_user";
+EOF
+`
+  if [[ $l_user_count -eq 0 ]]; then
+    echo "Not found user: $l_user"
+    exit 1;
+  fi
+}
+
+function unlock() {
+  if [[ $# -eq 0 ]]; then
+    echo "use command: '$0 unlock -u USERNAME'"
+    exit 1;
+  fi
+  local l_user="$1"
+  check_user l_user
+  sqlite3 $SQLITE_FILE <<EOF
+  update vat_user set locked=0 where username = "$l_user";
+EOF
+  clear_cache
+}
+
+function reset_password() {
+  if [[ $# -eq 0 ]]; then
+    echo "use command: '$0 reset_password -u USERNAME'"
+    exit 1;
+  fi
+  local l_user="$1"
+  check_user l_user
+  local l_password='$2a$10$XRz2ew7AX.StHRF.XptumuXSSSHiF4ylTCC5uDBO1l2z51maRnE82'
+  sqlite3 $SQLITE_FILE <<EOF
+  update vat_user set should_change_password=1, password="$l_password" where username = "$l_user";
+EOF
+  clear_cache
+}
+
+function user_list() {
+  sqlite3 $SQLITE_FILE <<EOF
+  select id, username from vat_user order by id;
+EOF
+}
+
+function print_help() {
+  echo "
+  help: print this help info.
+  list: list all user.
+  unlock: unlock user
+          flag: -u USERNAME
+  reset_password: reset user's password
+          flag: -u USERNAME
+  "
+}
+
+function clear_cache() {
+  touch 'file/db/.clear_cache'
+}
+
+cd "$(dirname $0)" || exit
+cd .. || exit
+
+SQLITE_FILE='file/db/sqlite.db'
+
+if [[ $# -eq 0 ]]; then
+  print_help;
+  exit 1;
+elif [[ $# -gt 0 ]]; then
+  COMMAND="$1"
+  shift
+fi
+
+
+while [[ $# -gt 0 ]]; do
+  key="$1"
+
+  case $key in
+    -u|--user)
+      G_USER="$2"
+      shift # past argument
+      shift # past value
+      ;;
+    *)    # unknown option
+      POSITIONAL+=("$1") # save it in an array for later
+      shift # past argument
+      ;;
+  esac
+done
+
+case $COMMAND in
+  list)
+    user_list
+    ;;
+  unlock)
+    unlock $G_USER
+    ;;
+  reset_password)
+    reset_password $G_USER
+    ;;
+  help)
+    print_help;
+    ;;
+  *)
+    echo "'$COMMAND' is not a legal command.";
+    echo "see '$0 help'"
+    exit 1
+    ;;
+esac

doc/system_maintenance_manual.md

@@ -105,6 +105,33 @@ You should change the default password after first login.
 
 You can create some normal users as needed.
 
+
+### Tool command
+
+We provide a tool script for resetting user passwords and unlocking users in the background.
+
+Unlock user
+```bash
+bin/tool.sh unlock -u USERNAME
+```
+
+Reset password for user
+```bash
+bin/tool.sh reset_password -u USERNAME
+```
+
+Help
+```bash
+bin/tool.sh help
+
+  help: print this help info.
+  list: list all user.
+  unlock: unlock user
+          flag: -u USERNAME
+  reset_password: reset user's password
+          flag: -u USERNAME
+```
+
 ## FAQ
 
 ### Why use python

docker/docker-run.sh

@@ -12,5 +12,5 @@ fi
 if [[ -f py/venv/bin/activate ]]; then
   source py/venv/bin/activate
 fi
-
-exec java -jar $(pwd)/jar/veritas-assessment-tool.jar
+JVM_OPT='-Dlog4j2.formatMsgNoLookups=true'
+exec java ${JVM_OPT} -jar $(pwd)/jar/veritas-assessment-tool.jar

pom.xml

@@ -10,7 +10,7 @@
     </parent>
     <groupId>org.veritas</groupId>
     <artifactId>assessment-tool</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
     <name>assessment</name>
     <description>Assessment tool of veritas.</description>
     <properties>
@@ -19,6 +19,7 @@
         <openhtml.version>1.0.10</openhtml.version>
         <springdoc.version>1.5.11</springdoc.version>
         <spring-boot.version>2.4.10</spring-boot.version>
+        <log4j2.version>2.15.0</log4j2.version>
 
         <config.directory>config</config.directory>
     </properties>

py/plot.py

@@ -64,7 +64,7 @@ def plot_calibration(bin_true_prob, bin_pred_prob, zf_name):
     ax1.plot(bin_pred_prob, bin_true_prob, "s-", color='#02124D',
              label="model")
 
-    ax1.set_ylabel("Fraction of loans that resolve", fontsize=14)
+    ax1.set_ylabel("Fraction of Positives", fontsize=14)
     ax1.set_ylim([-0.05, 1.05])
     ax1.legend(loc="lower right", fontsize=12)
     ax1.set_title('Model Calibration (reliability curve)', fontsize=16)
@@ -78,6 +78,7 @@ def plot_calibration(bin_true_prob, bin_pred_prob, zf_name):
 
 # plot heatmap
 def plot_heatmap(corr_values, feature_names, zf_name):
+    plt.figure(figsize=(9, 8))
     ax = sns.heatmap(
         corr_values,
         vmin=-1, vmax=1, center=0,
@@ -86,7 +87,7 @@ def plot_heatmap(corr_values, feature_names, zf_name):
     )
     ax.set_xticklabels(
         feature_names,
-        rotation=25,
+        rotation=45,
         horizontalalignment='right'
     )
     ax.set_yticklabels(
@@ -127,11 +128,11 @@ def plot_weighted_confusion_matrix(values, name1, name2, zf_name):
 
 
 # Plot contour
-def plot_contour(zf_name, key):
+def plot_contour(zf_name, key, fair_metric_name, perf_metric_name):
     plt.figure(figsize=(9, 8))
 #     plt.title('Fairness vs. Performance Tradeoffs', fontsize=18)
-    plt.xlabel('Lending Threshold Privileged', fontsize=16)
-    plt.ylabel('Lending Threshold Unprivileged', fontsize=16)
+    plt.xlabel(key+' Threshold Privileged', fontsize=16)
+    plt.ylabel(key+' Threshold Unprivileged', fontsize=16)
     plt.xlim(np.min(th_a), np.max(th_a))
     plt.ylim(np.min(th_b), np.max(th_b))
 
@@ -208,7 +209,7 @@ def plot_contour(zf_name, key):
 perf_dynamic = data['perf_dynamic']
 
 # plot weighted_confusion_matrix
-plot_weighted_confusion_matrix(weighted_confusion_matrix_list, ['Default', 'Repay'], ['Default', 'Repay'], zf_name)
+plot_weighted_confusion_matrix(weighted_confusion_matrix_list, ['Negative', 'Positive'], ['Negative', 'Positive'], zf_name)
 
 # plot class distribution
 plot_piechart(class_distribution_list, class_distribution_label, zf_name, '')
@@ -222,6 +223,10 @@ def plot_contour(zf_name, key):
 # plot perf dynamic
 plot_perf_dynamic(perf_dynamic['threshold'], perf_dynamic['perf'], perf_dynamic['selection_rate'], zf_name)
 for key in features_dict:
+    fair_metric_name = features_dict[key]['tradeoff']['fair_metric_name']
+    perf_metric_name = features_dict[key]['tradeoff']['perf_metric_name']
+    fair_metric_name = re.sub('_', ' ', fair_metric_name)
+    perf_metric_name = re.sub('_', ' ', perf_metric_name)
     th_a = features_dict[key]['tradeoff']['th_x']
     th_b = features_dict[key]['tradeoff']['th_y']
     perf = np.array(features_dict[key]['tradeoff']['perf'])
@@ -235,6 +240,6 @@ def plot_contour(zf_name, key):
     # plot feature_distribution
     plot_piechart(feature_distribution_list, feature_distribution_label, zf_name, key)
     # plot contour
-    plot_contour(zf_name, key)
+    plot_contour(zf_name, key, fair_metric_name, perf_metric_name)
 
 print(json.dumps(image_file_list))

src/main/java/org/veritas/assessment/AssessmentApplication.java

@@ -21,11 +21,13 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.scheduling.annotation.EnableScheduling;
 import org.veritas.assessment.system.config.VeritasProperties;
 
 @SpringBootApplication
 @MapperScan(basePackages = {"org.veritas.assessment.system.mapper", "org.veritas.assessment.biz.mapper"})
 @EnableCaching
+@EnableScheduling
 @EnableConfigurationProperties(VeritasProperties.class)
 public class AssessmentApplication {
 

src/main/java/org/veritas/assessment/biz/scheduled/CacheScheduledTask.java

@@ -0,0 +1,50 @@
+package org.veritas.assessment.biz.scheduled;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.io.FileUtils;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cache.Cache;
+import org.springframework.cache.CacheManager;
+import org.springframework.scheduling.annotation.Scheduled;
+import org.springframework.stereotype.Component;
+
+import java.io.File;
+
+@Component
+@Slf4j
+public class CacheScheduledTask {
+    @Autowired
+    private CacheManager cacheManager;
+
+    @Scheduled(fixedRate = 5 * 1000)
+    public void clearCacheSchedule() {
+        if (!needCleanCache()) {
+            return;
+        }
+        log.info("clear cache start...");
+        for (String name : cacheManager.getCacheNames()) {
+            Cache cache = cacheManager.getCache(name);
+            if (cache != null) {
+                cache.clear();
+            }
+        }
+        log.info("clear cache has finished.");
+
+    }
+
+    private boolean needCleanCache() {
+        File file = new File("file/db/.clear_cache");
+        boolean result = file.exists();
+        if (result) {
+            FileUtils.deleteQuietly(file);
+        }
+        if (log.isTraceEnabled()) {
+            if (result) {
+                log.trace("need to clear cache.");
+            } else {
+                log.trace("not need to clear cache.");
+            }
+        }
+        return result;
+    }
+}