Added cli feature (#6)

* Updated path to osspoi datastore

Author: asa1997

.gitignore

@@ -1 +1,6 @@
-ossp_data.json
+__pycache__/
+.vscode/
+.pytest_cache/
+dist/
+besecure_developer_toolkit/__pycache__/
+besecure_developer_toolkit/src/__pycache__/

README.md

@@ -1,28 +1,60 @@
-# besecure-developer-toolkit
+# Be-Secure Developer Toolkit (bes-dev-kit)
 
-The toolkit helps you to quickly generate meta data for BeSLighthouse visualisation. 
+bes-dev-kit is a cli tool for generating metadata and assessment report for [BeSLighthouse](https://github.com/Be-Secure/BeSLighthouse).
 
-It can generate the following data - 
-- ossp-master
-- version details
-- scorecard
-- criticality score
+# Installation
 
-## Pre-requisites
+`$ python3 -m pip install besecure-developer-toolkit`
 
-1. Python 3.x
-2. GitHub personal access token (classic).
-3. Set all the variables under [config](acc-config.cfg) file.
+# Pre-requisites
 
-## Keep in mind
+1. [Poetry](https://python-poetry.org/)
+2. Python 3.x
+3. pip
+4. Github personal access token
 
-1. Make sure the format of the version is correct under [Be-Secure/issues](https://github.com/Be-Secure/Be-Secure/issues).
-2. Name of the project is case-sensitive. Please provide the name of the project exactly as is given in their repository.
+# Setting env variables
+
+`Note: Should be done before testing/running`
+
+1. Creating a json file in your user home dir under the name `bes-dev-kit.json`.
+2. Copy the below contents and paste it inside the file.
 
-    ` Note:- Make sure you give the complete path to the directories`
+        {
+        "GITHUB_ORG": "Be-Secure",
+        "OSSPOI_DIR": "<complete_path_to>/besecure-osspoi-datastore",
+        "ASSESSMENT_DIR": "<complete_path_to>/besecure-assessment-datastore",
+        "GITHUB_AUTH_TOKEN": "<token>"
+        }
+3. Update `OSSPOI_DIR` and `ASSESSMENT_DIR` with complete path to your `besecure-assessment-datastore` and `besecure-osspoi-datastore`  dirs.
+4. Add your github personal access token
+
+
+# Setting up locally
+
+1. Install [poetry](https://python-poetry.org/). Use the [link](https://python-poetry.org/docs/) to install Poetry.
+2. Clone the repo.
+3. Move into the cloned directory.
+4. Create a new virtual env using Poetry - `$ poetry shell`
+5. Run the command to install the tool- `$ poetry install`
+6. Check installation - `$ bes-dev-kit --help`
+
+# Usage
+
+### Generate Metadata
+
+Command helps to generate metadata such as OSSP-master file data and version details file.
+
+`$ bes-dev-kit generate metadata`
+
+For more options use `--help` at end.
+
+### Generate Reports
+
+`$ bes-dev-kit generate report <report name>`
+
+`<report name> - scorecard, codeql, criticality_score`
+
+For more options use `--help` at end.
 
-## Usage
-1. Open terminal
-2. Using the below command, run [osspoi-meta-data-generator.sh](scripts/osspoi-meta-data-generator.sh) file.
-    
-    `$ ./osspoi-meta-data-generator.sh`
+`Note: All three reports can be generated at once by passing all report names - $ bes-dev-kit generate report scorecard criticality_score codeql`

acc-config.cfg

@@ -0,0 +1,19 @@
+"""Top-level package for Be-Secure Developer toolkit."""
+# src/__init__.py
+
+__app_name__ = "bes-dev-kit"
+__version__ = "0.0.1"
+
+(
+    SUCCESS,
+    DIR_ERROR,
+    FILE_ERROR,
+    JSON_ERROR,
+    ID_ERROR,
+) = range(5)
+
+ERRORS = {
+    DIR_ERROR: "config directory error",
+    FILE_ERROR: "config file error",
+    ID_ERROR: "to-do id error",
+}

besecure_developer_toolkit/__init__.py

@@ -0,0 +1,9 @@
+"""Be-Secure Developer Toolkit entry point script."""
+from besecure_developer_toolkit import cli, __app_name__
+
+def main():
+    
+    cli.app(prog_name=__app_name__)
+
+if __name__ == "__main__":
+    main()

besecure_developer_toolkit/__main__.py

@@ -0,0 +1,92 @@
+"""This module provides the Be-Secure Developer Toolkit CLI."""
+# src/cli.py
+import sys, os, json
+from typing import Optional
+from typing import List
+from rich import print
+import typer
+from besecure_developer_toolkit import __app_name__, __version__
+from besecure_developer_toolkit.src.CreateOsspMaster import OSSPMaster
+from besecure_developer_toolkit.src.CreateVersionData import Version
+from besecure_developer_toolkit.src.GenerateReport import Report
+
+def set_env_vars():
+    user_home = os.path.expanduser('~')
+    with open(user_home+'/bes_dev_kit.json', 'r') as f:
+        vars = json.load(f)
+    for key, value in vars.items():
+        os.environ[key] = str(value)
+
+set_env_vars()
+
+app = typer.Typer()
+
+generate_app = typer.Typer()
+
+app.add_typer(generate_app, name="generate")
+
+def _version_callback(value: bool) -> None:
+    if value:
+        typer.echo(f"{__app_name__} v{__version__}")
+        raise typer.Exit()
+
+
+
+@generate_app.command("metadata")
+def ossp(overwrite: bool = typer.Option(False, help="Overwrite the existing entries inside OSSP-master.json and version file")):
+    """ Update OSSP-master.json file and add/update version file to osspoi datastore """
+    try:
+        id = int(input("Enter OSSP id:"))
+    except ValueError:
+        sys.exit("Input should be of type int")
+    name = str(input("Enter OSSP name:"))
+    ossp_data = OSSPMaster(id, name)
+    ossp_data.GenerateOsspMaster(overwrite)
+    version_data = Version(id, name)
+    version_data.generate_version_data(overwrite)
+
+@generate_app.command("report")
+def report(reports: List[str], update_version_file: bool = typer.Option(True, help="Update version file with scorecard/criticality score")):
+    """ Following reports can be generated - scorecard, criticality_score, codeql"""
+    if len(reports) > 3:
+        print("[bold red]Alert! [green]Too many arguments")
+        raise typer.Exit()
+    else:
+        try:
+            id = int(input("Enter OSSP id:"))
+        except ValueError:
+            print("[bold red]Alert! [green]Expected type int")
+            raise typer.Exit()
+            
+        name = str(input("Enter OSSP name:"))
+        version = str(input("Enter version of "+ name +":"))
+        for i in reports:
+            if i == "scorecard":
+               scorecard_obj = Report(id, name, version, i)
+               scorecard_obj.main()
+               if update_version_file:
+                   scorecard_obj.update_version_data()
+            elif i == "criticality_score":
+                criticality_obj = Report(id, name, version, i)
+                criticality_obj.main()
+                if update_version_file:   
+                    criticality_obj.update_version_data()
+            elif i == "codeql":
+                codeql_obj = Report(id, name, version, i)
+                codeql_obj.main()
+    
+
+    
+@app.callback()
+def main(
+    version: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        "-v",
+        help="Show the application's version and exit.",
+        callback=_version_callback,
+        is_eager=True,
+    )
+): 
+
+    return

besecure_developer_toolkit/cli.py

@@ -0,0 +1,166 @@
+import sys, os, json, subprocess
+from urllib.request import urlopen
+from rich import print
+
+class OSSPMaster():
+    
+    def __init__(self, id: int, name: str) -> None:
+        self.id = id
+        self.name = name
+    
+    def check_issue_exists(self,id) -> None:
+        try:
+            urlopen('https://github.com/Be-Secure/Be-Secure/issues/'+str(id))
+        except Exception as e:
+            exc_type, exc_obj, exc_tb = sys.exc_info()
+            fname = os.path.split(exc_tb.tb_frame.f_code.co_filename)[1]
+            print(exc_type, fname, exc_tb.tb_lineno)
+            print("Could not find issue with id : "+str(id))
+            sys.exit()
+    
+    def check_issue_related_to_project(self):
+            
+        json_data = json.loads(urlopen(f'https://api.github.com/repos/Be-Secure/Be-Secure/issues/{self.id}').read())
+        issue_title = json_data["title"]
+        project_name = str(str(issue_title).split(":")[1]).replace(" ","")
+        if project_name != self.name:
+            print(f"[bold red]Alert! [yellow]Mismatch issue_id-project : [green] Issue id {self.id} does not match the project {self.name}")
+            sys.exit()
+        else:
+            pass
+
+        
+    
+    def check_repo_exists(self,name) -> None:
+        try:
+            urlopen('https://api.github.com/repos/Be-Secure/'+name)
+        except Exception as e:
+            exc_type, exc_obj, exc_tb = sys.exc_info()
+            fname = os.path.split(exc_tb.tb_frame.f_code.co_filename)[1]
+            print(exc_type, fname, exc_tb.tb_lineno)
+            print("Could not find "+ name +" under Be-Secure")
+            sys.exit()
+    
+    def write_tech_stack(self,bes_id):
+        raw_data = urlopen("https://api.github.com/repos/Be-Secure/Be-Secure/issues/"+str(bes_id))
+
+        data = json.loads(raw_data.read())
+
+        body_data = iter(data["body"].splitlines())
+        found = "false"
+        for i in body_data:
+            if i == "### Tech Stack":
+                found = "true"
+                continue
+            if len(i.strip()) == 0:
+                continue
+            if len(i.strip()) != 0 and found == "true":
+                s = str(i.split(" [")[1])
+                s = str(s.split("]")[0])
+                break    
+        return s
+    def write_project_repos_data(self,project_data):
+        project_repos = {
+        "main_github_url": "",
+        "main_bes_url": "",
+        "all_projects": [                                                                        
+            {
+                "id": 0,
+                "name": "",
+                "url": ""
+            }
+        ],
+        "all_bes_repos": [                                                                  
+            {
+                "id": 0,
+                "name": "",
+                "url": ""
+            }
+                    
+        ]
+        }
+        project_repos.update({"main_github_url": project_data["parent"]["html_url"]}) 
+        project_repos.update({"main_bes_url": project_data["html_url"]})
+        project_repos["all_projects"][0]["id"] = project_data["parent"]["id"]     
+        project_repos["all_projects"][0]["name"] = project_data["parent"]["full_name"]
+        project_repos["all_projects"][0]["url"] = project_data["parent"]["html_url"]
+        project_repos["all_bes_repos"][0]["id"] = project_data["id"]
+        project_repos["all_bes_repos"][0]["name"] = project_data["full_name"]
+        project_repos["all_bes_repos"][0]["url"] = project_data["html_url"]         
+        return project_repos
+
+    def write_tags(self, bes_id):
+        url = 'https://api.github.com/repos/Be-Secure/Be-Secure/issues/'+str(bes_id)+'/labels'
+        tags_json_data = urlopen(url)
+        tags_dict = json.loads(tags_json_data.read())
+        tags = []
+        for i in range(len(tags_dict)):
+            tags.append(tags_dict[i]["name"])
+        return tags
+    
+    def write_languages(self,name):
+        raw_data = urlopen("https://api.github.com/repos/Be-Secure/"+name+"/languages")
+        data = json.loads(raw_data.read())
+        return data
+    
+    def write_to_ossp_master(self, f, ossp_master_json, data, overwrite: bool):
+            if overwrite:
+                for i in range(len(ossp_master_json["items"])):
+                    if ossp_master_json["items"][i]["id"] == self.id:
+                        ossp_master_json["items"][i] = data
+                        break
+            else:    
+                ossp_master_json["items"].append(data)
+            f.seek(0)
+            f.write(json.dumps(ossp_master_json, indent=4))
+            f.truncate()
+        
+    
+    
+    def GenerateOsspMaster(self, overwrite: bool):
+        self.check_issue_exists(self.id)
+        self.check_repo_exists(self.name)
+        self.check_issue_related_to_project()
+        osspoi_dir = os.environ['OSSPOI_DIR']
+        namespace = os.environ['GITHUB_ORG']
+        token = os.environ['GITHUB_AUTH_TOKEN']
+        write_flag = True
+        f = open(osspoi_dir+"/OSSP-Master.json", "r+")
+        ossp_master_json = json.load(f)
+        if not overwrite:                 
+            for i in range(len(ossp_master_json["items"])):
+                if ossp_master_json["items"][i]["id"] == self.id:
+                    print("[bold red]Alert! [green]Entry for "+str(self.id)+"-"+self.name+" already present under OSSP-Master.json")
+                    write_flag = False
+                    break
+                else:
+                    write_flag = True
+        if write_flag:
+            # proc = subprocess.Popen([f'curl -L -H "Accept: application/vnd.github+json" -H "Authorization: Bearer <YOUR-TOKEN>"-H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com//{namespace}/{self.name}'], stdout=subprocess.PIPE, shell=True)
+            # (out, err) = proc.communicate()
+            url_data = urlopen('https://api.github.com/repos/Be-Secure/'+self.name)
+            project_data = json.loads(url_data.read())
+            ossp_data = json.loads('{}')
+            repo_keys = [ "id", "bes_tracking_id", "issue_url", "name", "full_name", "description", "bes_technology_stack", "watchers_count", "forks_count", "stargazers_count", "size", "open_issues", "created_at", "updated_at", "pushed_at", "git_url", "clone_url", "html_url", "homepage", "owner", "project_repos", "license", "language", "tags" ]
+            for i in repo_keys:
+                if i == "id" or i == "bes_tracking_id":
+                    ossp_data[i] = self.id
+                elif i == "issue_url":
+                    ossp_data[i] = 'https://github.com/Be-Secure/Be-Secure/issues/'+str(self.id)
+                elif i == "bes_technology_stack":
+                    ossp_data[i] = self.write_tech_stack(self.id)
+                elif i == "project_repos":
+                    ossp_data[i] = self.write_project_repos_data(project_data)
+                elif i == "tags":
+                    ossp_data[i] = self.write_tags(self.id)
+                elif i == "language":
+                    ossp_data[i] = self.write_languages(self.name)
+                else:
+                    ossp_data[i] = project_data[i]
+            self.write_to_ossp_master(f, ossp_master_json, ossp_data, overwrite)
+            f.close()        
+        
+        
+    
+    
+