gen_env.py

Go to the documentation of this file.

#!/usr/bin/env python3
# /*******************************************************************************
#  * Copyright 2016 -- 2022 IBM Corporation
#  *
#  * Licensed under the Apache License, Version 2.0 (the "License");
#  * you may not use this file except in compliance with the License.
#  * You may obtain a copy of the License at
#  *
#  *     http://www.apache.org/licenses/LICENSE-2.0
#  *
#  * Unless required by applicable law or agreed to in writing, software
#  * distributed under the License is distributed on an "AS IS" BASIS,
#  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  * See the License for the specific language governing permissions and
#  * limitations under the License.
# *******************************************************************************/
 
#  *
#  *                       cloudFPGA
#  *    =============================================
#  *     Created: FEB 2020
#  *     Authors: FAB, WEI, NGL
#  *
#  *     Description:
#  *       Python file to parse cFp.json
#  *
 
import json
import os
import re
 
__cfp_json_path__ = "/../cFp.json"
__env_file_name__ = "/this_machine_env.sh"
__to_be_defined_key__ = 'to-be-defined'
__lignin_key__ = 'lignin-conf'
__cfenv_small_name__ = 'cfenv-small'
__cfenv_path_from_root__ = '/env/' + __cfenv_small_name__ + '/'
__cfenv_req_packages__ = 'docopt==0.6.2 requests==2.26.0'
 
__mandatory_keys__ = ['cFpMOD', 'usedRoleDir', 'usedRoleDir2', 'cFpSRAtype', 'roleName1', 'roleName2']
__optional_keys__ = ['cFa', 'additional_lines', __lignin_key__]
 
__match_regex__ = []
__replace_regex__ = []
 
__match_regex__.append("##ROOTDIR##")
__replace_regex__.append("abs_path")
 
__match_regex__.append("##MOD##")
__replace_regex__.append("cFpMOD")
 
__match_regex__.append("##SRA##")
__replace_regex__.append("cFpSRAtype")
 
__match_regex__.append("##DIR1##")
__replace_regex__.append("usedRoleDir")
 
__match_regex__.append("##DIR2##")
__replace_regex__.append("usedRoleDir2")
 
__match_regex__.append("##ROLE1##")
__replace_regex__.append("roleName1")
 
__match_regex__.append("##ROLE2##")
__replace_regex__.append("roleName2")
 
__match_regex__.append("##virtual_path##")
__replace_regex__.append("cfenvPath")
 
__match_regex__.append("##python3_bin##")
__replace_regex__.append("sysPython3Bin")
 
 
def print_incomplete(msg=""):
    me_abs = os.path.realpath(__file__)
    cfp_json_file = os.path.abspath(me_abs + __cfp_json_path__)
    print("The project describing file {} is invalid.\n{}\n".format(cfp_json_file, msg) +
          "Please use 'cFBuild update' to fix this project setup.")
    exit(1)
 
 
def get_sys_python_env():
    # this is not working, we need the python3 without the virutalenv
    # sys_py_bin = os.popen('which python3').read()
    sys_py_bin = None
    if 'cFsysPy3_cmd_hint_0' in os.environ and os.path.isfile(os.environ['cFsysPy3_cmd_hint_0']):
        sys_py_bin = os.environ['cFsysPy3_cmd_hint_0']
    elif 'cFsysPy3_cmd_hint_1' in os.environ and os.path.isfile(os.environ['cFsysPy3_cmd_hint_1']):
        sys_py_bin = os.environ['cFsysPy3_cmd_hint_1']
    elif os.path.isfile('/usr/bin/python3.8'):
        sys_py_bin = '/usr/bin/python3.8'
    elif os.path.isfile('/usr/bin/python3'):
        sys_py_bin = '/usr/bin/python3'
    else:
        # as fallback, better than nothing
        # returns the virtualenv python
        sys_py_bin = os.popen('which python3').read()
    return sys_py_bin
 
 
def main():
    me_abs = os.path.dirname(os.path.realpath(__file__))
    cfp_json_file = me_abs + __cfp_json_path__
    with open(cfp_json_file, 'r') as json_file:
        data = json.load(json_file)
 
    root_abs = os.path.realpath(me_abs+"/../")
    data['abs_path'] = root_abs
    sys_py_bin = get_sys_python_env()
 
    # check for virtualenv
    cfenv_dir = os.path.abspath(root_abs + __cfenv_path_from_root__)
    if not os.path.isdir(cfenv_dir) or not os.path.isfile("{}/bin/activate".format(cfenv_dir)):
        # delete it, to be sure
        os.system("rm -rf {}".format(cfenv_dir))
        # creating it
        print("[INFO] the python virutalenv for this project on this machine is missing, installing it...")
        os.system('cd {}; virtualenv -p {} {}'
                  .format(os.path.abspath(cfenv_dir + '/../'), sys_py_bin, __cfenv_small_name__))
        os.system('/bin/bash -c "source {}/bin/activate; pip install {}"'.format(cfenv_dir, __cfenv_req_packages__))
 
    data['cfenvPath'] = cfenv_dir
    data['sysPython3Bin'] = sys_py_bin
 
    for e in __mandatory_keys__:
        if e not in data.keys():
            print_incomplete("The mandatory key {} is missing.".format(e))
 
    env_file = me_abs + __env_file_name__
 
    # first, check the timestamps
    if os.path.exists(env_file):
        json_time = os.path.getmtime(cfp_json_file)
        env_time = os.path.getmtime(env_file)
 
        if env_time >= json_time:
            # the environment was already created...nothing to do
            exit(0)
 
    with open(me_abs + "/machine_env.template", "r") as input, open(env_file, "w+") as outfile:
        out = input.read()
        for i in range(0, len(__match_regex__)):
            out = re.sub(re.escape(__match_regex__[i]), data[__replace_regex__[i]], out)
 
        if 'additional_lines' in data.keys():
            out += '\n\n'
            for e in data['additional_lines']:
                new_line = str(e) + '\n'
                out += new_line
            out += '\n\n'
 
        outfile.write(out)
 
    os.system("chmod +x {}".format(env_file))
 
 
if __name__ == '__main__':
    main()
    exit(0)