Added unit tests for TemporaryDirectory, ScriptFinder and GitReposito…

…ry. (opensearch-project#311)

DEVELOPER_GUIDE.md

@@ -8,6 +8,7 @@
   - [Run Tests](#run-tests)
   - [Run bundle-workflow](#run-bundle-workflow)
   - [Code Linting](#code-linting)
+  - [Pre-Commit Cheatsheet](#pre-commit-cheatsheet)
 
 ## Developer Guide
 
@@ -107,4 +108,17 @@ All done! ✨ 🍰 ✨
 23 files left unchanged.
 ```
 
-If your code isn't properly formatted, don't worry, [a CI workflow](./github/workflows/test-bundle-workflow.yml) will make sure to remind you. 
+If your code isn't properly formatted, don't worry, [a CI workflow](./github/workflows/test-bundle-workflow.yml) will make sure to remind you. 
+
+### Pre-Commit Cheatsheet
+
+Run from `bundle-workflow` before making pull requests.
+
+```
+cd bundle-workflow
+
+pipenv run isort .
+pipenv run black .
+pipenv run flake8
+pipenv run pytest
+```

bundle-workflow/assemble.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -e
 

bundle-workflow/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -e
 

bundle-workflow/run.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -e
 

bundle-workflow/scripts/components/OpenSearch/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/OpenSearch/integtest.sh

@@ -0,0 +1 @@
+# TODO: This is used by script_finder tests, needs a working integtest.sh for OpenSearch.

bundle-workflow/scripts/components/alerting/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/common-utils/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/dashboards-notebooks/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/dashboards-reports/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/job-scheduler/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/k-NN/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/k-NN/install.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/notifications/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/performance-analyzer-rca/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/performance-analyzer/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/performance-analyzer/install.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/components/security/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/default/build.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/scripts/default/install.sh

@@ -1,7 +1,10 @@
 #!/bin/bash
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 set -ex
 

bundle-workflow/src/assemble.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import argparse
 import os

bundle-workflow/src/assemble_workflow/bundle.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 import shutil

bundle-workflow/src/assemble_workflow/bundle_recorder.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 from urllib.parse import urljoin

bundle-workflow/src/build.py

@@ -1,7 +1,10 @@
 #!/usr/bin/env python
 
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 import uuid

bundle-workflow/src/build_workflow/build_args.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import argparse
 import sys

bundle-workflow/src/build_workflow/build_recorder.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 import shutil

bundle-workflow/src/build_workflow/builder.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 

bundle-workflow/src/git/git_repository.py

@@ -1,5 +1,8 @@
-# Copyright OpenSearch Contributors.
 # SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
 
 import os
 import subprocess
@@ -20,6 +23,7 @@ def __init__(self, url, ref, directory=None):
             self.temp_dir = tempfile.TemporaryDirectory()
             self.dir = self.temp_dir.name
         else:
+            self.temp_dir = None
             self.dir = directory
             os.makedirs(self.dir, exist_ok=False)