Move to Python project for easily to leverage Trestle (#10)

* move go project to go/ Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * update makefile to build cp2cli as submodule Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * update docs for url changes Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * import c2p python project Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * update README.md for message of deprecating C2P in Go Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * add Code of Conduct, Contributor guide, and maintainers list Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> * update go/README.md release guide Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com> --------- Signed-off-by: Takumi Yanagawa <yana@jp.ibm.com>
oscal-compass · May 2, 2024 · d8eb84e · d8eb84e
1 parent 36a42c8
commit d8eb84e
Show file tree

Hide file tree

Showing 509 changed files with 8,361 additions and 589 deletions.
diff --git a/...ub/workflows/create-and-publish-image.yml → ...ed-workflows/create-and-publish-image.yml b/...ub/workflows/create-and-publish-image.yml → ...ed-workflows/create-and-publish-image.yml
diff --git a/.github/workflows/goreleaser-workflow.yml → ...isabled-workflows/goreleaser-workflow.yml b/.github/workflows/goreleaser-workflow.yml → ...isabled-workflows/goreleaser-workflow.yml
diff --git a/.gitignore b/.gitignore
@@ -1,43 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
+# C extensions
 *.so
-*.dylib
-bin
-testbin/*
-Dockerfile.cross
 
-# Test binary, build with `go test -c`
-*.test
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
 
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
 
-# Kubernetes Generated files - skip generated files, except for vendored files
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
 
-!vendor/**/zz_generated.*
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
 
-# editor and IDE paraphernalia
-.idea
-*.swp
-*.swo
-*~
+# Translations
+*.mo
+*.pot
 
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
 
-# IDE
-.vscode
-.idea
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
 
-# Output of gorelease
-dist
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
 
-# ignore output by test
-/**/_test
+# SageMath parsed files
+*.sage.py
 
-# 
-policy-collection
-out
-work
-kubeconfig.*
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# vscode
+.vscode
+config/**/*.local.*
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,21 @@
+# This is an example configuration to enable detect-secrets in the pre-commit hook.
+# Add this file to the root folder of your repository.
+#
+# Read pre-commit hook framework https://pre-commit.com/ for more details about the structure of config yaml file and how git pre-commit would invoke each hook.
+#
+# This line indicates we will use the hook from ibm/detect-secrets to run scan during committing phase.
+repos:
+  - repo: https://github.com/ibm/detect-secrets
+    # If you desire to use a specific version of detect-secrets, you can replace `master` with other git revisions such as branch, tag or commit sha.
+    # You are encouraged to use static refs such as tags, instead of branch name
+    #
+    # Running "pre-commit autoupdate" automatically updates rev to latest tag
+    rev: 0.13.1+ibm.61.dss
+    hooks:
+      - id: detect-secrets # pragma: whitelist secret
+        # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.
+        # You may also run `pre-commit run detect-secrets` to preview the scan result.
+        # when "--baseline" without "--use-all-plugins", pre-commit scan with just plugins in baseline file
+        # when "--baseline" with "--use-all-plugins", pre-commit scan with all available plugins
+        # add "--fail-on-unaudited" to fail pre-commit for unaudited potential secrets
+        args: [--baseline, .secrets.baseline, --use-all-plugins]
diff --git a/.secrets.baseline b/.secrets.baseline
@@ -0,0 +1,152 @@
+{
+  "exclude": {
+    "files": "go/go.sum|^.secrets.baseline$",
+    "lines": null
+  },
+  "generated_at": "2024-04-28T07:58:38Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "BoxDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "ghe_instance": "github.ibm.com",
+      "name": "GheDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {
+    "README.md": [
+      {
+        "hashed_secret": "845d87d073c35614bfe1fe7f7f3821ea0f175126",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 279,
+        "type": "Base64 High Entropy String",
+        "verified_result": null
+      }
+    ],
+    "go/controllers/utils/gitrepo/gitrepo.go": [
+      {
+        "hashed_secret": "3aa3f05a1cbf42942040995f7e6842769216bdbc",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 104,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "go/controllers/utils/utils.go": [
+      {
+        "hashed_secret": "49531b78f7258280352a3f4d6679d963f7cc430c",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 308,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "746637d90e70b787088b90792a905d7e450dd379",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 308,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "go/docs/ocm/README.md": [
+      {
+        "hashed_secret": "21c50805b553b7a40e48394a5d77d442587ddee2",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 141,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ],
+    "go/pkg/gitutils.go": [
+      {
+        "hashed_secret": "49531b78f7258280352a3f4d6679d963f7cc430c",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 154,
+        "type": "Secret Keyword",
+        "verified_result": null
+      },
+      {
+        "hashed_secret": "746637d90e70b787088b90792a905d7e450dd379",
+        "is_secret": false,
+        "is_verified": false,
+        "line_number": 154,
+        "type": "Secret Keyword",
+        "verified_result": null
+      }
+    ]
+  },
+  "version": "0.13.1+ibm.61.dss",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,3 @@
+# Contributor Covenant Code of Conduct
+
+Following to [Code of Conduct of OSCAL COMPASS project](https://github.com/oscal-compass/compliance-trestle/blob/develop/CODE_OF_CONDUCT.md).