NASA MAAP API

The joint ESA-NASA Multi-Mission Algorithm and Analysis Platform (MAAP) focuses on developing a collaborative data system enabling collocated data, processing, and analysis tools for NASA and ESA datasets. The NASA MAAP API adheres to the joint ESA-NASA MAAP API specification currently in development. This joint architectural approach enables NASA and ESA to each run independent MAAPs, while ultimately sharing common facilities to share and integrate collocated platform services.

Development server: https://api.dit.maap-project.org/api

I. Local development using docker

Set your FERNET_KEY environment variable to be a key, doesn't necessarily need to be valid.

See instructions for generating a test key: https://cryptography.io/en/latest/fernet/

cd docker
docker-compose -f docker-compose-local.yml up

Once you make code changes you might need to delete your maap-api-nasa docker image for these code changes to be reflected. If you are getting a network not found error, try running docker-compose -f docker-compose-local.yml up --force-recreate You may need to add these keys to your docker compose environment variables to get the api running correctly/ being able to submit jobs: FERNET_KEY, GITLAB_TOKEN, CAS_PROXY_DECRYPTION_TOKEN, CAS_SECRET_KEY, CAS_SERVER_NAME, REGISTER_JOB_REPO_ID, GITLAB_API_TOKEN, GIT_REPO_URL, GITLAB_POST_PROCESS_TOKEN, MOZART_URL, MOZART_V1_URL, THIRD_PARTY_SECRET_TOKEN, MAAP_TEMP_URS_TOKEN
If you make changes to the settings, rebuild with docker-compose -f docker-compose-local.yml build --no-cache

II. Local development using poetry and virtualenv

Prerequisites:

• poetry
  • https://python-poetry.org/docs/#installation
• postgresql
  • Linux: sudo apt-get install postgresql python-psycopy2 libpq-dev
  • Mac OSx: brew install postgresql
• python3.9+

cd maap-api-nasa
poetry install

First run: Configure the database.

1. Add a new user called maapuser (A fix for 'role does not exist')

   NOTE: You may need to use sudo -u postgres before postgres commands.

   createuser maapuser

2. Create an empty postgres db (maap) (a fix for 'database maap does not exist'):

   createdatabase maap

3. OPTIONAL: PyCharm configuration, if using the PyCharm IDE:

• Script path: ./api/maapapp.py
• Environment variables: PYTHONUNBUFFERED=1
• Python interpreter: Python 3.9
• Working directory: ./api

(Obsolete?) Config Titiler endpoint and maap-api-host

In the settings.py (i.e., maap-api-nasa/api/settings.py):

# settings.py
API_HOST_URL = 'http://0.0.0.0:5000/' # For local testing

# ...

# The endpoint obtained after doing Titiler deployment
TILER_ENDPOINT = 'https://XXX.execute-api.us-east-1.amazonaws.com'
# If running the tiler locally, this can be TILER_ENDPOINT = 'http://localhost:8000'

Run the app:

poetry shell
FLASK_APP=api/maapapp.py flask run --host=0.0.0.0

Some issues you may experience while running the above line:

• Allowing using postgres without login (A fix for 'fe_sendauth: no password supplied'):

  sudo vi /etc/postgresql/9.5/main/pg_hba.conf #(the location may be different depend on OS and postgres version)

  # Reconfig as follows:
      local   all     all     trust
      host    all     all     127.0.0.1/32    trust
      host    all     all     ::1/0           trust
  # Save pg_hba.conf
  

  # Restart postgresql
  sudo /etc/init.d/postgresql reload
  sudo /etc/init.d/postgresql start

Running Tests

Prerequisites

• Local development environment set up (see CLAUDE.md)
• Test database configured
• Required environment variables set

Test Execution Commands

Local Development

# Build and run all tests
./scripts/run-tests.sh

# Run specific test categories
docker-compose -f docker/docker-compose-test.yml run --rm test pytest test/api/endpoints/

# Run tests with coverage
docker-compose -f docker/docker-compose-test.yml run --rm test pytest --cov=api --cov-report=html

# Run tests in watch mode
docker-compose -f docker/docker-compose-test.yml run --rm test pytest -f

Debugging Tests

# Run tests with detailed output
docker-compose -f docker/docker-compose-test.yml run --rm test pytest -vvv -s

# Run specific test
docker-compose -f docker/docker-compose-test.yml run --rm test pytest test/api/endpoints/test_members.py::TestMemberManagement::test_new_member_can_be_created_successfully

# Run with debugger
docker-compose -f docker/docker-compose-test.yml run --rm test pytest --pdb

Test Execution

# Run all tests
python -m unittest discover test/

# Run specific test modules
python -m unittest test.api.endpoints.test_members
python -m unittest test.api.utils.test_email

# Run individual test methods
python -m unittest test.api.endpoints.test_members.MembersCase.test_create_member

III. User Accounts

A valid MAAP API token must be included in the header for any API request. An Earthdata account is required to access the MAAP API. To obtain a token, URS credentials must be provided as shown below:

curl -X POST --header "Content-Type: application/json" -d "{ \"username\": \"urs_username\", \"password\": \"urs_password\" }" https://api.dit.maap-project.org/token

Comments:

• After running the local maap-api-nasa, go to http://0.0.0.0:5000/api to see the APIs.

• Or running the your own test scripts with:

curl -X POST --header "Content-Type: application/json" -d "{ \"username\": \"urs_username\", \"password\": \"urs_password\" }" http://0.0.0.0:5000/token