-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from FiniteStateInc/v0.0.4-dev
v0.0.4 RC
- Loading branch information
Showing
14 changed files
with
4,450 additions
and
4,036 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # pdoc docs-template | ||
|
|
||
| Custom documentation template for use with `pdoc` documenation generator. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| {# | ||
| We want to extend the default template instead of defining everything ourselves. | ||
| #} | ||
| {% extends "default/module.html.jinja2" %} | ||
|
|
||
| {# | ||
| We can redefine individual blocks. | ||
| For example, if the `--favicon` option does not do what you want, you can specify a replacement like this. | ||
| #} | ||
| {% block favicon %} | ||
| <link rel="shortcut icon" href="https://finitestate.io/hubfs/cropped-fs-favicon-01-1-32x32.png"/> | ||
| {% endblock %} | ||
|
|
||
| {# | ||
| We can access system environment variables in the template, for example to pass version information. | ||
| #} | ||
| {% block nav_footer %} | ||
| <footer>finite-state-sdk-python v{{ env["VERSION"] }}</footer> | ||
| {% endblock %} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| import finite_state_sdk | ||
| import json | ||
| import os | ||
|
|
||
| """ | ||
| This is an example of uploading test results from a third party scanner such as an SCA or SAST tool. | ||
| NOTE, the create_new_asset_version_and_upload_test_results function is a convenience function that | ||
| can be used as the basis for integration with your CI/CD pipeline. | ||
| Uploading Test Results to Finite State | ||
| To upload test results, you will need: | ||
| * Business Unit ID (get this from the API or app, see this example) | ||
| * Created By User ID (get this from the API or app) | ||
| * An Asset ID (get this from the API or app, see this example) | ||
| * A version name (you make this up, or it comes from your build system, e.g. 1.0, 1.2, etc.) | ||
| * A File Path (this is the path to the file on your local machine) | ||
| * Test Result file type - in this case we are uploading a CycloneDX SBOM file | ||
| In this example: | ||
| * We assume that you have already created an Asset, and are creating a new AssetVersion for that Asset. This corresponds to analyzing a new version of your source code, for example. | ||
| Note: An Asset and AssetVersion may or may not be related to a Product. In this example, it is not. | ||
| To install the SDK, use pip: | ||
| pip install finite-state-sdk | ||
| """ | ||
|
|
||
| """ | ||
| You can store your secrets in a file called .env in the same directory as this script | ||
| that looks like: | ||
| export CLIENT_ID="your client id" | ||
| export CLIENT_SECRET="your client secret" | ||
| export ORGANIZATION_CONTEXT="your organization context" | ||
| Before running the script, run the following command in the terminal: | ||
| source .env | ||
| DO NOT COMMIT THIS FILE TO YOUR SOURCE CODE REPOSITORY!!! | ||
| """ | ||
|
|
||
| # get CLIENT_ID and CLIENT_SECRET from env | ||
| CLIENT_ID = os.environ.get("CLIENT_ID") | ||
| CLIENT_SECRET = os.environ.get("CLIENT_SECRET") | ||
| ORGANIZATION_CONTEXT = os.environ.get("ORGANIZATION_CONTEXT") | ||
|
|
||
|
|
||
| # Get an auth token - this is a bearer token that you will use for all subsequent requests | ||
| # The token is valid for 24 hours | ||
| token = finite_state_sdk.get_auth_token(CLIENT_ID, CLIENT_SECRET) | ||
|
|
||
| # get all business units to get the business_unit_id | ||
| business_units = finite_state_sdk.get_all_business_units(token, ORGANIZATION_CONTEXT) | ||
| # print(json.dumps(business_units, indent=4)) | ||
|
|
||
| """ | ||
| Example Response: | ||
| [ | ||
| { | ||
| "_cursor": "{\"id\":\"xxxxxxxx28\"}", | ||
| "id": "xxxxxxxx28", | ||
| "name": "Finite State Products" | ||
| } | ||
| ] | ||
| """ | ||
|
|
||
| # You can also get this from the app by clicking Account and navigating to the Business Unit | ||
| business_unit_id = "" # CHANGEME: Get the business unit ID of the BU that owns the product | ||
|
|
||
| # get all users to get the user id | ||
| users = finite_state_sdk.get_all_users(token, ORGANIZATION_CONTEXT) | ||
| print(json.dumps(users, indent=4)) | ||
|
|
||
| """ | ||
| Example Response: | ||
| [ | ||
| { | ||
| "_cursor": "{\"id\":\"xxxxxxx73\"}", | ||
| "id": "xxxxxxx73", | ||
| "email": "[email protected]" | ||
| } | ||
| ] | ||
| """ | ||
|
|
||
| # You can also get this from the app by clicking Account and navigating to the User | ||
| created_by_user_id = "" # CHANGEME: Get the user ID to associate with the creation of the product | ||
|
|
||
| # You can also get this from the app by navigating to the Asset, this ID is the number in the URL | ||
| # https://platform.finitestate.io/artifacts/<YOUR_ASSET_ID> | ||
| asset_id = "" # CHANGEME: Get the asset ID to associate with the binary | ||
|
|
||
| file_path = "" # CHANGEME: Path to the file you want to upload | ||
| version_name = "" # CHANGEME: Name of the version you are uploading (e.g. 1.0, 1.1, or the commit hash of your source code repository, etc.) | ||
|
|
||
| # upload the test results | ||
| # NOTE: you must specify the test result file type | ||
| # In this case we are uploading a CycloneDX SBOM, so we use the value "cyclonedx" | ||
| response = finite_state_sdk.create_new_asset_version_and_upload_test_results(token, ORGANIZATION_CONTEXT, business_unit_id=business_unit_id, created_by_user_id=created_by_user_id, asset_id=asset_id, version=version_name, file_path=file_path, product_id=None, artifact_description="Source Code Repository", test_type="cyclonedx") | ||
| print("Uploaded the test results:") | ||
| print(json.dumps(response, indent=4)) | ||
|
|
||
| """ | ||
| Example Response: | ||
| { | ||
| "completeTestResultUpload": { | ||
| "key": "test_results/org=xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/asset_version=xxxxxxxx69/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx3bb" | ||
| } | ||
| } | ||
| """ |
Oops, something went wrong.