Skip to content

Commit 4f4cf93

Browse files
JEJodestyJEJodesty
committed
update readme with/and tests
1 parent b52a651 commit 4f4cf93

File tree

4 files changed

+31
-40
lines changed

4 files changed

+31
-40
lines changed

‎README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ IPFS. Connecting these network planes enables the execution of the cloud service
3636
GCP, Azure, etc. on a **Data Mesh** network of CATs.
3737

3838
## Installation:
39-
4039
0. **Install [Dependencies](./docs/INSTALL.md)**
4140
1. **Install CATs:**
4241
```bash
@@ -45,8 +44,6 @@ GCP, Azure, etc. on a **Data Mesh** network of CATs.
4544
python -m pip install --upgrade pip
4645
pip install -r requirements.txt
4746
```
48-
49-
## Testing:
5047

5148
## [Demo:](./cats_demo.ipynb)
5249
CATs' demo utilizes [Ray](https://www.ray.io/), a unified compute framework for interoperable distributed computing
@@ -86,8 +83,8 @@ Execute a CATs on a single node Mesh.
8683
jupyter notebook cats_demo.ipynb
8784
# Run > Run All Cells
8885
```
89-
##### [Testing](./tests/verification_test.py): `pytest -s tests/verification_test.py`
90-
* Requirement: Step 3
86+
* [**Tests**](./tests/verification_test.py): `pytest -s tests/verification_test.py`
87+
* Requirement: Step 3
9188

9289
## Data Service Collaboration:
9390
CATs streamline Data Service collaboration between organizations by providing a reliable and efficient way to manage,

‎cats_demo.ipynb

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"name": "stderr",
1111
"output_type": "stream",
1212
"text": [
13-
"/tmp/ipykernel_4173120/1461130463.py:2: FutureWarning: The `ipfsapi` library is deprecated and will stop receiving updates on the 31.12.2019! If you are on Python 3.5+ please enable and fix all Python deprecation warnings (CPython flag `-Wd`) and switch to the new `ipfshttpclient` library name. Python 2.7 and 3.4 will not be supported by the new library, so please upgrade.\n",
13+
"/tmp/ipykernel_124287/1461130463.py:2: FutureWarning: The `ipfsapi` library is deprecated and will stop receiving updates on the 31.12.2019! If you are on Python 3.5+ please enable and fix all Python deprecation warnings (CPython flag `-Wd`) and switch to the new `ipfshttpclient` library name. Python 2.7 and 3.4 will not be supported by the new library, so please upgrade.\n",
1414
" import ipfsapi as ipfsApi\n"
1515
]
1616
}
@@ -126,7 +126,7 @@
126126
"text": [
127127
" % Total % Received % Xferd Average Speed Time Time Time Current\n",
128128
" Dload Upload Total Spent Left Speed\n",
129-
"100 63 0 0 0 63 0 0 --:--:-- 0:01:37 --:--:-- 0"
129+
"100 278 100 215 0 63 2 0 0:01:47 0:01:33 0:00:14 62\n"
130130
]
131131
},
132132
{
@@ -136,10 +136,10 @@
136136
"{'POST': 'curl -X POST -H \"Content-Type: application/json\" -d \\'{\"order_cid\": '\n",
137137
" '\"QmSmGTZTUaFyhxdfp8uLrAWPvkREmRq1vxbnPYEVTvw2Xu\"}\\' '\n",
138138
" 'http://127.0.0.1:5000/cat/node/init',\n",
139-
" 'bom': {'invoice_cid': 'Qmbt1FnfaW4TCvZR5UsMD7kGDyCRnboqa1fwRXNoVtdvDF',\n",
140-
" 'log_cid': 'QmWu3LCbyGBKb1Z5V5472UVVcvaCZCv1a4Kydw7Az3eATR'},\n",
141-
" 'bom_cid': 'QmTpwZpUGEty4vtYBjNoFMgEnUuXfwn65xXe9jCNuDWG5m',\n",
142-
" 'flat_bom': {'invoice': {'data_cid': 'QmcAKb37o6t1ZPi3AvciczxdS3pz6fG3Yq851fGkEqczZp',\n",
139+
" 'bom': {'invoice_cid': 'QmXUaNBEZR3BgRvosxuMYzb3G71piW7MXt1jTpzQxGgKzt',\n",
140+
" 'log_cid': 'QmRvJaPH2KSTTg4WcQpCopqmUBMHs4NoFHLDafNR24iksg'},\n",
141+
" 'bom_cid': 'QmdFDNHNdHxG798sgtX9a6ALdYDffa7dp5TLiD3WLhcfh4',\n",
142+
" 'flat_bom': {'invoice': {'data_cid': 'QmdCLefpJfvbChyu2mjZmG37wFucgHd2sMPDaZzcsQvrZw',\n",
143143
" 'order': {'endpoint': 'http://127.0.0.1:5000/cat/node/init',\n",
144144
" 'flat': {'function': {'infrafunction_cid': None,\n",
145145
" 'process_cid': 'QmXqKpSVBuoZD2QG8hT3tTF8ai6cHV8iTHt2tF5sM3scmc'},\n",
@@ -150,16 +150,9 @@
150150
" 'structure_filepath': 'main.tf'},\n",
151151
" 'order_cid': 'QmSmGTZTUaFyhxdfp8uLrAWPvkREmRq1vxbnPYEVTvw2Xu',\n",
152152
" 'seed_cid': None},\n",
153-
" 'log': {'egress_job_id': '9d0bde7a-be21-4c2c-a86b-3a5ef023f890',\n",
154-
" 'ingress_job_id': 'fe25aa52-d232-49e7-b6ae-443b64aac05c',\n",
155-
" 'integration_output': 's3://catstore3/boms/result-20240123-fe25aa52-d232-49e7-b6ae-443b64aac05c-integrated'}}}\n"
156-
]
157-
},
158-
{
159-
"name": "stderr",
160-
"output_type": "stream",
161-
"text": [
162-
"100 278 100 215 0 63 2 0 0:01:47 0:01:37 0:00:10 60\n"
153+
" 'log': {'egress_job_id': '13f8318f-a69e-41cb-8117-176539a82744',\n",
154+
" 'ingress_job_id': '69f93ce2-df7e-4a27-a05e-1ec13c5813a5',\n",
155+
" 'integration_output': 's3://catstore3/boms/result-20240123-69f93ce2-df7e-4a27-a05e-1ec13c5813a5-integrated'}}}\n"
163156
]
164157
}
165158
],
@@ -189,7 +182,7 @@
189182
"name": "stdout",
190183
"output_type": "stream",
191184
"text": [
192-
"{'order_cid': 'QmXmDDYJpiQRABXifxddinBvxL715QnUARuuihSB7D6qBJ'}\n"
185+
"{'order_cid': 'QmNU5EAmWNDc7U3bjZ8X2rzjD3iN83KXcarsvnyk8AXA9o'}\n"
193186
]
194187
}
195188
],
@@ -220,14 +213,14 @@
220213
"\n",
221214
"{'endpoint': 'http://127.0.0.1:5000/cat/node/link',\n",
222215
" 'function_cid': 'QmXoU3V8JWvHm12rbsm4czhQAS1k47ESY5Uto1Pqekb87q',\n",
223-
" 'invoice_cid': 'QmUvzmuFAyxRdyHQg1K8RgqZAzZntqarjZQiKgvibzmJFP',\n",
216+
" 'invoice_cid': 'QmU62uGkaqZyrvyAqAggiDDzmo7aTX745gb6kbzkk5R66y',\n",
224217
" 'structure_cid': 'QmYyFroE2Nw1BVg3D1MQdeZFrMAn9XWYHgWueMUKaRGops',\n",
225218
" 'structure_filepath': 'main.tf'}\n",
226219
"\n",
227220
"\n",
228221
"curl -X POST -H \"Content-Type: application/json\" -d \\\n",
229222
"'{\n",
230-
" \"order_cid\": \"QmXmDDYJpiQRABXifxddinBvxL715QnUARuuihSB7D6qBJ\"\n",
223+
" \"order_cid\": \"QmNU5EAmWNDc7U3bjZ8X2rzjD3iN83KXcarsvnyk8AXA9o\"\n",
231224
"}' http://127.0.0.1:5000/cat/node/link\n",
232225
"\n",
233226
"\n"
@@ -239,40 +232,40 @@
239232
"text": [
240233
" % Total % Received % Xferd Average Speed Time Time Time Current\n",
241234
" Dload Upload Total Spent Left Speed\n",
242-
"100 63 0 0 0 63 0 0 --:--:-- 0:02:34 --:--:-- 063 0 315 --:--:-- --:--:-- --:--:-- 313"
235+
"100 63 0 0 0 63 0 0 --:--:-- 0:02:35 --:--:-- 0"
243236
]
244237
},
245238
{
246239
"name": "stdout",
247240
"output_type": "stream",
248241
"text": [
249242
"{'POST': 'curl -X POST -H \"Content-Type: application/json\" -d \\'{\"order_cid\": '\n",
250-
" '\"QmXmDDYJpiQRABXifxddinBvxL715QnUARuuihSB7D6qBJ\"}\\' '\n",
243+
" '\"QmNU5EAmWNDc7U3bjZ8X2rzjD3iN83KXcarsvnyk8AXA9o\"}\\' '\n",
251244
" 'http://127.0.0.1:5000/cat/node/link',\n",
252-
" 'bom': {'invoice_cid': 'QmTn5mNqyvhRq3XN8psZsUc7UWcTFYS2rkyuT2nNfu8TrP',\n",
253-
" 'log_cid': 'QmUzLKGdziF5usuT9x7AYZe1VV5DkXzpaT8vAwu9gnR9Ar'},\n",
254-
" 'bom_cid': 'QmUdVovpSP47zFV6yEoEEBKAnCdhe27bnBP9BXZhKe7kfC',\n",
255-
" 'flat_bom': {'invoice': {'data_cid': 'QmVxgWgkKyKsgoo53sU1avXBDkDw2vHSFrpNjD9q5Umg7v',\n",
245+
" 'bom': {'invoice_cid': 'Qma8s7kaqqdSw6tLkV4e1KZXAT8UPnqzU5MjD49pZUigd9',\n",
246+
" 'log_cid': 'QmeyyQVpGhPwbBk588MZjxMGEbfTdSBjXbn6wHyDrYXnwp'},\n",
247+
" 'bom_cid': 'Qmc58h4o1V8Dv7Z8goXUNKMTU3MF2YTG4V7Ug2VCu2hX3H',\n",
248+
" 'flat_bom': {'invoice': {'data_cid': 'QmeVuroH6jX8j8jC2wE2suMwVVN5YicK8q9FGYEigrHZ9J',\n",
256249
" 'order': {'endpoint': 'http://127.0.0.1:5000/cat/node/link',\n",
257250
" 'flat': {'function': {'infrafunction': None,\n",
258251
" 'process_cid': 'QmXC2XLDePUxCoPtETPejd5uwF3BcaoQNAn2vRU4a4BK7z'},\n",
259-
" 'invoice': {'data_cid': 'QmcAKb37o6t1ZPi3AvciczxdS3pz6fG3Yq851fGkEqczZp'}},\n",
252+
" 'invoice': {'data_cid': 'QmdCLefpJfvbChyu2mjZmG37wFucgHd2sMPDaZzcsQvrZw'}},\n",
260253
" 'function_cid': 'QmXoU3V8JWvHm12rbsm4czhQAS1k47ESY5Uto1Pqekb87q',\n",
261-
" 'invoice_cid': 'QmUvzmuFAyxRdyHQg1K8RgqZAzZntqarjZQiKgvibzmJFP',\n",
254+
" 'invoice_cid': 'QmU62uGkaqZyrvyAqAggiDDzmo7aTX745gb6kbzkk5R66y',\n",
262255
" 'structure_cid': 'QmYyFroE2Nw1BVg3D1MQdeZFrMAn9XWYHgWueMUKaRGops',\n",
263256
" 'structure_filepath': 'main.tf'},\n",
264-
" 'order_cid': 'QmXmDDYJpiQRABXifxddinBvxL715QnUARuuihSB7D6qBJ',\n",
257+
" 'order_cid': 'QmNU5EAmWNDc7U3bjZ8X2rzjD3iN83KXcarsvnyk8AXA9o',\n",
265258
" 'seed_cid': None},\n",
266-
" 'log': {'egress_job_id': '82378fda-b6f3-4243-81e3-1839ba2d2d83',\n",
267-
" 'ingress_job_id': 'fc1f418f-d0a9-4918-b778-934db669fe10',\n",
268-
" 'integration_output': 's3://catstore3/boms/result-20240123-fc1f418f-d0a9-4918-b778-934db669fe10-integrated'}}}\n"
259+
" 'log': {'egress_job_id': '2c01bad7-00df-4220-9755-0a022112d3cd',\n",
260+
" 'ingress_job_id': 'a1983925-6bdc-4dfc-9d42-d4fb1d23e8d4',\n",
261+
" 'integration_output': 's3://catstore3/boms/result-20240123-a1983925-6bdc-4dfc-9d42-d4fb1d23e8d4-integrated'}}}\n"
269262
]
270263
},
271264
{
272265
"name": "stderr",
273266
"output_type": "stream",
274267
"text": [
275-
"100 278 100 215 0 63 1 0 0:03:35 0:02:35 0:01:00 55\n"
268+
"100 278 100 215 0 63 1 0 0:03:35 0:02:35 0:01:00 66\n"
276269
]
277270
}
278271
],

‎docs/INSTALL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
##### Install Requirements:
2-
0. **[Python](https://www.python.org/downloads/)** (>= 3.10.13)
2+
0. **[Python](https://www.python.org/downloads/release/python-31013/)** (>= 3.10.13)
33
1. **[kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installing-from-release-binaries)** (>= 0.12.0)
44
2. **[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)** (>= 1.22.2)
55
3. **[helm](https://helm.sh/docs/intro/install/)** (>= v3.13.1)
@@ -9,4 +9,5 @@
99
```
1010
5. **[Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)** (>= 1.5.2)
1111
6. **[IPFS Kubo](https://docs.ipfs.tech/install/command-line/#system-requirements)** (0.24.0)
12-
7. **[AWS S3](https://aws.amazon.com/s3/)**
12+
7. **[AWS S3](https://aws.amazon.com/s3/)**
13+
1. Requires: **[AWS Account](https://aws.amazon.com/free)**

‎tests/verification_test.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
endpoint='http://127.0.0.1:5000/cat/node/init'
1919
)
2020
cat_invoiced_response_0 = service.catSubmit(cat_order_request_0)
21-
cat_order_request_1 = service.linkProcess(cat_invoiced_response_0, process_1)
2221

2322

2423
class TestDataVerificationCAT0:
@@ -41,6 +40,7 @@ def test_cat0_data_verification(self):
4140
)
4241

4342

43+
cat_order_request_1 = service.linkProcess(cat_invoiced_response_0, process_1)
4444
class TestDataVerificationCAT1:
4545
cat_invoiced_response_1 = service.catSubmit(cat_order_request_1)
4646
flat_cat_invoiced_response_1 = service.flatten_bom(cat_invoiced_response_1)

0 commit comments

Comments
 (0)