Merge pull request #2 from NehaDC-IMC/processor-template-with-openapi-cookiecutter

Processor template with openapi cookiecutter

Author: marcserrat

README.md

@@ -0,0 +1,107 @@
+# Cookiecutter for CloudBlue Connect Reports  
+  
+Powered by [Cookiecutter](https://github.com/cookiecutter/cookiecutter), Cookiecutter for CloudBlue Connect Reports provides a framework for boostraping your custom reports for Connect.
+
+With this project you can write your own reports to execute either locally or using the reports module of Connect.
+
+In order to create your own custom report you will need to get familiar with the [Connect Rest API](https://connect.cloudblue.com/community/api/) and it's OpenAPI implementation using the [connect-openapi-client](https://github.com/cloudblue/connect-python-openapi-client).
+
+## Features
+
+* Works fit python 3.8 and 3.9
+* Bootstraps a custom report project within seconds
+* Provides all needed dependencies
+* Provides basic testing functionality including right mockers
+* Compatible with github Actions
+* Configures project licensing
+
+## Usage
+
+Creating a project that provides a report package that could be run either using the [Connect CLI](https://github.com/cloudblue/connect-cli) or directly in [Connect](https://connect.cloudblue.com) is simple.
+
+First of all, install in your local machine Cookiecutter, for example you can do it using pip:
+
+	$ pip install cookiecutter
+
+Once cookiecutter is installed you can instantiate it against this repository:
+
+	$ cookiecutter https://github.com/cloudblue/connect-report-python-boilerplate 
+ 
+ You'll be prompted for some values. Provide them and a Connect project will be created for you.
+
+**Warning**: Please change sample data with your own desired information
+
+	project_name [My Awesome Project]: My Awesome Project
+	project_slug [my_awesome_project]:
+	description [My reports are really usefull!]:
+	package_name [reports]:
+	initial_report_name [My Awesome Report]: My Awesome Report
+	initial_report_slug [my_awesome_report]:
+	initial_report_description [This report provides all data i need]:
+	author [Globex Corporation]: ISV Inc
+	version [0.1.0]: 1.0.0
+	Select license:
+	1 - Apache Software License 2.0
+	2 - MIT
+	3 - BSD
+	Choose from 1, 2, 3 [1]: 1
+	use_github_actions [y]: y
+	Done! Your report project is ready to go!
+
+Now you can access your recently created project folder and take a look arround it:
+
+	$ cd my_awesome_report
+	$ ls
+
+Starting here, if you want you can put your project on a git repository, for example at github:
+
+	$ git init
+	$ git add .
+	$ git commit -m "first commit"
+	$ git remote add origin https://github.com/cloudblue/my_custom_report.git
+	$ git push -u origin master
+
+In the use case that you decided to use github actions, you will notice that a first CI task will run, this one will run the sample test
+
+## Creating your own report
+
+The creation of a requires some knowladge of [Connect Rest API](https://connect.cloudblue.com/community/api/) and the [connect-openapi-client](https://github.com/cloudblue/connect-python-openapi-client). 
+
+First, edit the reports.json file, this file is a descriptor that can be read by Connect as well as Connect CLI to understand your package. Please ensure that all properties are defined. On the parameters list, you can define the parameters that will be asked to be populated by who runs the report, just select the ones you need as described in our community portal.
+
+The code of your report must be defined at your entrypoint, here is where system will find your function that will receive an instantiated client, this client is the openapi one and can work with our API, additionally you will get a function that you must invoke in order to update the progress
+
+Job done? Try to run it locally!
+
+	$ ccli report list -d ./my_awesome_project
+
+	************************************************************
+
+	My Awesome Project version 1.0.0
+
+	************************************************************
+
+	Welcome to My Awesome Project !
+
+	My reports are really usefull!
+
+	License
+
+	My Awesome Project is licensed under the Apache Software License 2.0 license.
+
+
+	************************************************************
+
+	List of available reports:
+
+	Report ID: my_awesome_report - Report name: My Awesome Project
+
+Now if you want you can execute it also using ccli
+
+	$ ccli report execute my_awesome_report_1 -d ./my_awesome_report
+
+## Examples
+
+All our reports that you can run from Connect platform are available to you, if you want to take a look at them and it's code visit our github repository available [here](https://github.com/cloudblue/connect-reports)
+
+Please take a look to our oficial [documentation site](https://connect.cloudblue.com) for more information on how to work with reports

cookiecutter.json

@@ -0,0 +1,15 @@
+{
+    "project_name": "My Connect Processor",
+    "project_slug": "{{ cookiecutter.project_name.lower()|replace(' ', '_')|replace('-', '_')|replace('.', '_')|trim() }}",
+    "description": "My processor will auto-process subscription requests in CloudBlue Connect",
+    "author": "CloudBlue Vendor",
+    "version": "0.1.0",
+    "license": [
+        "Apache Software License 2.0",
+        "MIT",
+        "BSD"
+    ],
+    "Require_subscription_change_usecase": "y/n",
+	"Require_subscription_cancel_usecase": "y/n",
+	"Require_subscription_suspend_and_resume_usecases": "y/n"
+}

hooks/post_gen_project.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect Report Python Boilerplate.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+import os
+import shutil
+import string
+import sys
+import pathlib
+
+PROJECT_DIRECTORY = os.path.realpath(os.path.curdir)
+
+
+def remove_license():
+        os.remove('LICENSE')
+
+def remove_file(filepath):
+    os.remove(os.path.join(PROJECT_DIRECTORY, filepath))
+
+def main():
+    if '{{ cookiecutter.license }}' == 'Other, not Open-source':
+        remove_license()
+    
+    if '{{ cookiecutter.Require_subscription_change_usecase }}'.lower() == 'n':
+        c_file = os.path.join('connect_processor','app','change.py')
+        remove_file(c_file)
+
+    if '{{ cookiecutter.Require_subscription_cancel_usecase }}'.lower() == 'n':
+        c_file = os.path.join('connect_processor', 'app', 'cancel.py')
+        remove_file(c_file)
+
+    if '{{ cookiecutter.Require_subscription_suspend_and_resume_usecases }}'.lower() == 'n':
+        c_file = os.path.join('connect_processor', 'app', 'suspend.py')
+        remove_file(c_file)
+        c_file = os.path.join('connect_processor', 'app', 'resume.py')
+        remove_file(c_file)
+
+
+    print('Done! Your report project is ready to go!')
+
+if __name__ == '__main__':
+    main()

hooks/pre_gen_project.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+# This file is part of the Ingram Micro Cloud Blue Connect Processor Template Python Boilerplate.
+# Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
+
+
+project_slug = '{{ cookiecutter.project_slug }}'
+if hasattr(project_slug, 'isidentifier'):
+    assert (
+        project_slug.isidentifier()
+    ), '`{}` project slug is not a valid Python identifier.'.format(project_slug)
+
+assert (
+    project_slug == project_slug.lower()
+), '`{}` project slug should be all lowercase'.format(project_slug)

{{cookiecutter.project_slug}}/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+exclude = .idea,.vscode,.git,pg_data,venv,env,msmiddleware/settings/*.py,*/migrations/*.py,
+show-source = True
+max-line-length = 100
+application-import-names = smarkets
+max-cognitive-complexity = 15
+ignore = FI1,I100,W503
+

{{cookiecutter.project_slug}}/.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+htmlcov
+.coverage
+coverage.xml