Merge pull request #2976 from gargaroff/htc/dev/dmontada-session-file…

…-env

feat(credential_manager): allow users to overwrite location of session file

docs/web/authentication.md

@@ -372,6 +372,11 @@ The location of the password file can be configured by the `CC_PASS_FILE`
 environment variable. This environment variable can also be used to setup
 different credential files to login to the same server with a different user.
 
+Furthermore, the location of the session file can be configured by the
+`CC_SESSION_FILE` environment variable. This can be useful if CodeChecker does
+not have the permission to create a session file under the user's home
+directory (e.g. in some CI environments).
+
 ### Automatic login <a name="automatic-login"></a>
 
 If authentication is required by the server and the user hasn't logged in but

docs/web/user_guide.md

@@ -235,6 +235,14 @@ environment variables:
                    It can also be used to setup different credential files to
                    login to the same server with a different user.
 
+  CC_SESSION_FILE  The location of the session file where valid sessions are
+                   stored. This file will be automatically created by
+                   CodeChecker. By default CodeChecker will use
+                   '~/.codechecker.session.json'. This can be used if
+                   restrictive permissions forbid CodeChecker from creating
+                   files in the users home directory (e.g. in a CI
+                   environment).
+
 The results can be viewed by connecting to such a server in a Web browser or
 via 'CodeChecker cmd'.
 ```

web/client/codechecker_client/cmd/store.py

@@ -129,6 +129,14 @@ def get_argparser_ctor_args():
                    It can also be used to setup different credential files to
                    login to the same server with a different user.
 
+  CC_SESSION_FILE  The location of the session file where valid sessions are
+                   stored. This file will be automatically created by
+                   CodeChecker. By default CodeChecker will use
+                   '~/.codechecker.session.json'. This can be used if
+                   restrictive permissions forbid CodeChecker from creating
+                   files in the users home directory (e.g. in a CI
+                   environment).
+
 
 The results can be viewed by connecting to such a server in a Web browser or
 via 'CodeChecker cmd'.""",

web/client/codechecker_client/credential_manager.py

@@ -10,7 +10,6 @@
 tokens.
 """
 
-
 import json
 import os
 import re
@@ -21,7 +20,8 @@
 from codechecker_common.logger import get_logger
 from codechecker_common.util import load_json_or_empty
 
-from codechecker_web.shared.env import check_file_owner_rw, get_password_file
+from codechecker_web.shared.env import check_file_owner_rw, get_password_file,\
+    get_session_file
 from codechecker_web.shared.version import SESSION_COOKIE_NAME as _SCN
 
 LOG = get_logger('system')
@@ -95,7 +95,7 @@ def __init__(self):
         self.__save = scfg_dict
         self.__autologin = scfg_dict.get('client_autologin', True)
         # Check and load token storage for user.
-        self.token_file = os.path.join(user_home, ".codechecker.session.json")
+        self.token_file = get_session_file()
         LOG.info("Checking for local valid sessions.")
 
         if os.path.exists(self.token_file):

web/codechecker_web/shared/env.py

@@ -33,6 +33,13 @@ def get_password_file():
                                        ".codechecker.passwords.json"))
 
 
+def get_session_file():
+    """ Return the location of the CodeChecker session file. """
+    return os.environ.get("CC_SESSION_FILE",
+                          os.path.join(os.path.expanduser("~"),
+                                       ".codechecker.session.json"))
+
+
 def get_user_input(msg):
     """
     Get the user input.

web/server/vue-cli/e2e/init.db.js

@@ -9,6 +9,7 @@ const url = `http://${host}:${port}`;
 const CC_DIR = path.join(__dirname, "__codechecker");
 const REPORTS_DIR = path.join(CC_DIR, "reports");
 const PASSWORD_FILE = path.join(CC_DIR, "codechecker.passwords.json");
+const SESSION_FILE = path.join(CC_DIR, "codechecker.session.json");
 
 // List of products which will be added to the server.
 const PRODUCTS = [
@@ -73,7 +74,8 @@ async function login (username) {
     stdio: "inherit",
     env: {
       ...process.env,
-      "CC_PASS_FILE": PASSWORD_FILE
+      "CC_PASS_FILE": PASSWORD_FILE,
+      "CC_SESSION_FILE": SESSION_FILE
     }
   });
 }