Add BDC_STAC_ASSETS_ARGS(close #130) and .drone.yml improvements

brazil-data-cube · Jan 27, 2021 · eb2ebc2 · eb2ebc2
1 parent 110048a
commit eb2ebc2
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 38 deletions.
diff --git a/.drone.yml b/.drone.yml
@@ -1,4 +1,5 @@
 kind: pipeline
+type: docker
 name: default
 
 steps:
@@ -8,10 +9,29 @@ steps:
     - pip install --upgrade pip
     - pip install --upgrade setuptools
     - pip install -e.[all]
-    - isort bdc_stac tests setup.py --check-only --diff
-    - check-manifest --ignore ".drone.yml,.readthedocs.yml"
-    - sphinx-build -qnW --color -b doctest docs/sphinx/ docs/sphinx/_build/doctest
-    # - pytest -v TODO: Review tests
+    - ./run-tests.sh
+
+- name: discord-notify
+  image: brazildatacube/bdc-drone-discord
+  settings:
+    webhook:
+      from_secret: discord_webhook
+  when:
+    status:
+      - failure
+      - success
+
+- name: coverage
+  image: plugins/codecov
+  settings:
+    token:
+      from_secret: codecov_token
+    files:
+      - coverage.xml
+      - .coverage
+  when:
+    event:
+      - push
 
 - name: docker-registry
   image: plugins/docker

diff --git a/bdc_stac/config.py b/bdc_stac/config.py
@@ -24,7 +24,7 @@
 BDC_STAC_MAX_LIMIT = int(os.getenv("BDC_STAC_MAX_LIMIT", "1000"))
 BDC_STAC_TITLE = os.getenv("BDC_STAC_TITLE", "Brazil Data Cube Catalog")
 BDC_STAC_ID = os.getenv("BDC_STAC_ID", "bdc")
-
+BDC_STAC_ASSETS_ARGS = os.getenv("BDC_STAC_ASSETS_ARGS", None)
 BDC_AUTH_CLIENT_SECRET = os.getenv("BDC_AUTH_CLIENT_SECRET", None)
 BDC_AUTH_CLIENT_ID = os.getenv("BDC_AUTH_CLIENT_ID", None)
 BDC_AUTH_ACCESS_TOKEN_URL = os.getenv("BDC_AUTH_ACCESS_TOKEN_URL", None)
diff --git a/bdc_stac/data.py b/bdc_stac/data.py
@@ -124,7 +124,11 @@ def get_collection_items(
                 where += [
                     func.ST_Intersects(
                         func.ST_MakeEnvelope(
-                            split_bbox[0], split_bbox[1], split_bbox[2], split_bbox[3], func.ST_SRID(Item.geom),
+                            split_bbox[0],
+                            split_bbox[1],
+                            split_bbox[2],
+                            split_bbox[3],
+                            func.ST_SRID(Item.geom),
                         ),
                         Item.geom,
                     )
@@ -460,15 +464,22 @@ def get_catalog(roles=[]):
     """
     collections = (
         session.query(
-            Collection.id, func.concat(Collection.name, "-", Collection.version).label("name"), Collection.title,
+            Collection.id,
+            func.concat(Collection.name, "-", Collection.version).label("name"),
+            Collection.title,
+        )
+        .filter(
+            or_(
+                Collection.is_public.is_(True),
+                Collection.id.in_([int(r.split(":")[0]) for r in roles]),
+            )
         )
-        .filter(or_(Collection.is_public.is_(True), Collection.id.in_([int(r.split(":")[0]) for r in roles]),))
         .all()
     )
     return collections
 
 
-def make_geojson(items, links, access_token=""):
+def make_geojson(items, links, assets_kwargs=""):
     """Generate a list of STAC Items from a list of collection items.
 
     :param items: collection items to be formated as GeoJSON Features
@@ -512,7 +523,8 @@ def make_geojson(items, links, access_token=""):
         properties["eo:cloud_cover"] = i.cloud_cover
 
         for key, value in i.assets.items():
-            value["href"] = BDC_STAC_FILE_ROOT + value["href"] + access_token
+            value["href"] = BDC_STAC_FILE_ROOT + value["href"] + assets_kwargs
+
             for index, band in enumerate(properties["eo:bands"], start=0):
                 if band["name"] == key:
                     value["eo:bands"] = [index]
@@ -531,9 +543,9 @@ def make_geojson(items, links, access_token=""):
         feature["assets"] = i.assets
 
         feature["links"] = deepcopy(links)
-        feature["links"][0]["href"] += i.collection + "/items/" + i.item + access_token
-        feature["links"][1]["href"] += i.collection + access_token
-        feature["links"][2]["href"] += i.collection + access_token
+        feature["links"][0]["href"] += i.collection + "/items/" + i.item + assets_kwargs
+        feature["links"][1]["href"] += i.collection + assets_kwargs
+        feature["links"][2]["href"] += i.collection + assets_kwargs
 
         features.append(feature)
 

diff --git a/bdc_stac/routes.py b/bdc_stac/routes.py
@@ -14,7 +14,7 @@
 from werkzeug.exceptions import HTTPException, InternalServerError
 from werkzeug.urls import url_encode
 
-from .config import BDC_STAC_API_VERSION, BDC_STAC_BASE_URL, BDC_STAC_ID, BDC_STAC_TITLE
+from .config import BDC_STAC_API_VERSION, BDC_STAC_ASSETS_ARGS, BDC_STAC_BASE_URL, BDC_STAC_ID, BDC_STAC_TITLE
 from .data import InvalidBoundingBoxError, get_catalog, get_collection_items, get_collections, make_geojson, session
 
 BASE_URL = BDC_STAC_BASE_URL
@@ -71,7 +71,13 @@ def conformance():
 @oauth2(required=False, throw_exception=False)
 def index(roles=[], access_token=""):
     """Landing page of this API."""
-    access_token = f"?access_token={access_token}" if access_token else ""
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
 
     collections = get_catalog(roles=roles)
     catalog = dict()
@@ -100,7 +106,7 @@ def index(roles=[], access_token=""):
     for collection in collections:
         links.append(
             {
-                "href": f"{BASE_URL}/collections/{collection.name}{access_token}",
+                "href": f"{BASE_URL}/collections/{collection.name}{assets_kwargs}",
                 "rel": "child",
                 "type": "application/json",
                 "title": collection.title,
@@ -116,33 +122,39 @@ def index(roles=[], access_token=""):
 @oauth2(required=False, throw_exception=False)
 def root(roles=[], access_token=""):
     """Return the root catalog or collection."""
-    access_token = f"?access_token={access_token}" if access_token else ""
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
 
     collections = get_collections(roles=roles)
     response = dict()
 
     for collection in collections:
         links = [
             {
-                "href": f"{BASE_URL}/collections/{collection['id']}{access_token}",
+                "href": f"{BASE_URL}/collections/{collection['id']}{assets_kwargs}",
                 "rel": "self",
                 "type": "application/json",
                 "title": "Link to this document",
             },
             {
-                "href": f"{BASE_URL}/collections/{collection['id']}/items{access_token}",
+                "href": f"{BASE_URL}/collections/{collection['id']}/items{assets_kwargs}",
                 "rel": "items",
                 "type": "application/json",
                 "title": f"Items of the collection {collection['id']}",
             },
             {
-                "href": f"{BASE_URL}/collections{access_token}",
+                "href": f"{BASE_URL}/collections{assets_kwargs}",
                 "rel": "parent",
                 "type": "application/json",
                 "title": "Link to catalog collections",
             },
             {
-                "href": f"{BASE_URL}/{access_token}",
+                "href": f"{BASE_URL}/{assets_kwargs}",
                 "rel": "root",
                 "type": "application/json",
                 "title": "API landing page (root catalog)",
@@ -162,7 +174,13 @@ def collections_id(collection_id, roles=[], access_token=""):
 
     :param collection_id: identifier (name) of a specific collection
     """
-    access_token = f"?access_token={access_token}" if access_token else ""
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
 
     collection = get_collections(collection_id, roles=roles)
 
@@ -173,25 +191,25 @@ def collections_id(collection_id, roles=[], access_token=""):
 
     links = [
         {
-            "href": f"{BASE_URL}/collections/{collection['id']}{access_token}",
+            "href": f"{BASE_URL}/collections/{collection['id']}{assets_kwargs}",
             "rel": "self",
             "type": "application/json",
             "title": "Link to this document",
         },
         {
-            "href": f"{BASE_URL}/collections/{collection['id']}/items{access_token}",
+            "href": f"{BASE_URL}/collections/{collection['id']}/items{assets_kwargs}",
             "rel": "items",
             "type": "application/json",
             "title": f"Items of the collection {collection['id']}",
         },
         {
-            "href": f"{BASE_URL}/collections{access_token}",
+            "href": f"{BASE_URL}/collections{assets_kwargs}",
             "rel": "parent",
             "type": "application/json",
             "title": "Link to catalog collections",
         },
         {
-            "href": f"{BASE_URL}/{access_token}",
+            "href": f"{BASE_URL}/{assets_kwargs}",
             "rel": "root",
             "type": "application/json",
             "title": "API landing page (root catalog)",
@@ -210,8 +228,6 @@ def collection_items(collection_id, roles=[], access_token=""):
 
     :param collection_id: identifier (name) of a specific collection
     """
-    access_token = f"?access_token={access_token}" if access_token else ""
-
     items = get_collection_items(collection_id=collection_id, roles=roles, **request.args.to_dict())
 
     links = [
@@ -241,7 +257,15 @@ def collection_items(collection_id, roles=[], access_token=""):
     gjson["stac_extensions"] = ["checksum", "commons", "context", "eo"]
     gjson["type"] = "FeatureCollection"
 
-    features = make_geojson(items.items, links, access_token=access_token)
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
+
+    features = make_geojson(items.items, links, assets_kwargs=assets_kwargs)
 
     gjson["links"] = []
 
@@ -275,8 +299,6 @@ def items_id(collection_id, item_id, roles=[], access_token=""):
     :param collection_id: identifier (name) of a specific collection
     :param item_id: identifier (name) of a specific item
     """
-    access_token = f"?access_token={access_token}" if access_token else ""
-
     item = get_collection_items(collection_id=collection_id, roles=roles, item_id=item_id)
     links = [
         {"href": f"{BASE_URL}/collections/", "rel": "self"},
@@ -285,7 +307,15 @@ def items_id(collection_id, item_id, roles=[], access_token=""):
         {"href": f"{BASE_URL}/", "rel": "root"},
     ]
 
-    gjson = make_geojson(item.items, links, access_token=access_token)
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
+
+    gjson = make_geojson(item.items, links, assets_kwargs=assets_kwargs)
 
     if len(gjson) > 0:
         return gjson[0]
@@ -297,8 +327,6 @@ def items_id(collection_id, item_id, roles=[], access_token=""):
 @oauth2(required=False, throw_exception=False)
 def stac_search(roles=[], access_token=""):
     """Search STAC items with simple filtering."""
-    access_token = f"?access_token={access_token}" if access_token else ""
-
     bbox, datetime, ids, collections, page, limit, intersects, query = None, None, None, None, None, None, None, None
     if request.method == "POST":
         if request.is_json:
@@ -355,7 +383,15 @@ def stac_search(roles=[], access_token=""):
     gjson = dict()
     gjson["type"] = "FeatureCollection"
 
-    features = make_geojson(items.items, links, access_token=access_token)
+    assets_kwargs = None
+
+    if BDC_STAC_ASSETS_ARGS:
+        assets_kwargs = {arg: request.args.get(arg) for arg in BDC_STAC_ASSETS_ARGS.split(",")}
+        if access_token:
+            assets_kwargs["access_token"] = access_token
+        assets_kwargs = "?" + url_encode(assets_kwargs)
+
+    features = make_geojson(items.items, links, assets_kwargs=assets_kwargs)
 
     gjson["links"] = []
     context = dict()
@@ -378,6 +414,7 @@ def stac_search(roles=[], access_token=""):
 
 @current_app.route("/schemas/<string:schema_name>")
 def list_schema(schema_name):
+    """Return jsonschemas."""
     return send_from_directory("spec/jsonschemas", schema_name)
 
 

diff --git a/run-tests.sh b/run-tests.sh
@@ -10,6 +10,7 @@
 pydocstyle bdc_stac tests setup.py && \
 isort bdc_stac tests setup.py --check-only --diff && \
 black --check --diff -l 120 -t py37 bdc_stac tests setup.py  && \
-check-manifest --ignore ".travis-*" --ignore ".readthedocs.*" && \
-sphinx-build -qnW --color -b doctest docs/sphinx/ docs/sphinx/_build/doctest  && \
-pytest
+check-manifest --ignore ".drone.yml,.readthedocs.yml" && \
+sphinx-build -qnW --color -b doctest docs/sphinx/ docs/sphinx/_build/doctest
+# pytest Fix tests
+