Test out and document how to upgrade the service

[jordanpadams]

When you perform an upgrade of the service we need to make sure:

• does the database get maintained?
• is there anything extra the SA / operator needs to do besides pip install pds.doi-service --upgrade

[collinss-jpl]

Performed an upgrade from v2.0.0 to v2.0.1 of DOI service on pds-gamma using pip install pds-doi-service --upgrade. Result:

Requirement already satisfied: pds-doi-service in ./lib/python3.9/site-packages (2.0.0)
Collecting pds-doi-service
  Downloading pds_doi_service-2.0.1-py3-none-any.whl (208 kB)
     |████████████████████████████████| 208 kB 20.5 MB/s
Requirement already satisfied: python-dateutil>=2.8 in ./lib/python3.9/site-packages (from pds-doi-service) (2.8.2)
Requirement already satisfied: Flask==1.1.2 in ./lib/python3.9/site-packages (from pds-doi-service) (1.1.2)
Requirement already satisfied: pytz==2020.1 in ./lib/python3.9/site-packages (from pds-doi-service) (2020.1)
Requirement already satisfied: appdirs>=1.4 in ./lib/python3.9/site-packages (from pds-doi-service) (1.4.4)
Requirement already satisfied: idna==2.9 in ./lib/python3.9/site-packages (from pds-doi-service) (2.9)
Requirement already satisfied: numpy>=1.18 in ./lib/python3.9/site-packages (from pds-doi-service) (1.21.2)
Requirement already satisfied: openpyxl==3.0 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.0)
Requirement already satisfied: jsonschema==3.0.0 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.0)
Requirement already satisfied: jinja2==3.0.1 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.1)
Requirement already satisfied: requests>=2.23 in ./lib/python3.9/site-packages (from pds-doi-service) (2.26.0)
Requirement already satisfied: flask-cors==3.0.9 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.9)
Requirement already satisfied: waitress==2.0.0 in ./lib/python3.9/site-packages (from pds-doi-service) (2.0.0)
Requirement already satisfied: xmlschema==1.5.1 in ./lib/python3.9/site-packages (from pds-doi-service) (1.5.1)
Requirement already satisfied: bs4==0.0.1 in ./lib/python3.9/site-packages (from pds-doi-service) (0.0.1)
Requirement already satisfied: six>=1.14 in ./lib/python3.9/site-packages (from pds-doi-service) (1.16.0)
Requirement already satisfied: lxml>=4.5 in ./lib/python3.9/site-packages (from pds-doi-service) (4.6.3)
Requirement already satisfied: wheel in ./lib/python3.9/site-packages (from pds-doi-service) (0.37.0)
Requirement already satisfied: Werkzeug==0.16.0 in ./lib/python3.9/site-packages (from pds-doi-service) (0.16.0)
Requirement already satisfied: chardet==3.0.4 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.4)
Requirement already satisfied: connexion[swagger-ui]==2.7.0 in ./lib/python3.9/site-packages (from pds-doi-service) (2.7.0)
Requirement already satisfied: zipp>=3.1 in ./lib/python3.9/site-packages (from pds-doi-service) (3.5.0)
Requirement already satisfied: urllib3>=1.25 in ./lib/python3.9/site-packages (from pds-doi-service) (1.26.7)
Requirement already satisfied: nltk==3.5 in ./lib/python3.9/site-packages (from pds-doi-service) (3.5)
Requirement already satisfied: openapi-schema-validator==0.1.4 in ./lib/python3.9/site-packages (from pds-doi-service) (0.1.4)
Requirement already satisfied: pandas>=1.0 in ./lib/python3.9/site-packages (from pds-doi-service) (1.3.3)
Requirement already satisfied: certifi==2020.4.5.1 in ./lib/python3.9/site-packages (from pds-doi-service) (2020.4.5.1)
Requirement already satisfied: xlrd>=1.2 in ./lib/python3.9/site-packages (from pds-doi-service) (2.0.1)
Requirement already satisfied: filelock==3.0.12 in ./lib/python3.9/site-packages (from pds-doi-service) (3.0.12)
Requirement already satisfied: xmltodict>=0.12 in ./lib/python3.9/site-packages (from pds-doi-service) (0.12.0)
Requirement already satisfied: soupsieve>=2.0 in ./lib/python3.9/site-packages (from pds-doi-service) (2.2.1)
Requirement already satisfied: distlib==0.3.1 in ./lib/python3.9/site-packages (from pds-doi-service) (0.3.1)
Requirement already satisfied: beautifulsoup4 in ./lib/python3.9/site-packages (from bs4==0.0.1->pds-doi-service) (4.10.0)
Requirement already satisfied: inflection>=0.3.1 in ./lib/python3.9/site-packages (from connexion[swagger-ui]==2.7.0->pds-doi-service) (0.5.1)
Requirement already satisfied: openapi-spec-validator>=0.2.4 in ./lib/python3.9/site-packages (from connexion[swagger-ui]==2.7.0->pds-doi-service) (0.3.1)
Requirement already satisfied: clickclick>=1.2 in ./lib/python3.9/site-packages (from connexion[swagger-ui]==2.7.0->pds-doi-service) (20.10.2)
Requirement already satisfied: PyYAML>=5.1 in ./lib/python3.9/site-packages (from connexion[swagger-ui]==2.7.0->pds-doi-service) (5.4.1)
Requirement already satisfied: swagger-ui-bundle>=0.0.2 in ./lib/python3.9/site-packages (from connexion[swagger-ui]==2.7.0->pds-doi-service) (0.0.9)
Requirement already satisfied: click>=5.1 in ./lib/python3.9/site-packages (from Flask==1.1.2->pds-doi-service) (8.0.1)
Requirement already satisfied: itsdangerous>=0.24 in ./lib/python3.9/site-packages (from Flask==1.1.2->pds-doi-service) (2.0.1)
Requirement already satisfied: MarkupSafe>=2.0 in ./lib/python3.9/site-packages (from jinja2==3.0.1->pds-doi-service) (2.0.1)
Requirement already satisfied: setuptools in ./lib/python3.9/site-packages (from jsonschema==3.0.0->pds-doi-service) (56.0.0)
Requirement already satisfied: pyrsistent>=0.14.0 in ./lib/python3.9/site-packages (from jsonschema==3.0.0->pds-doi-service) (0.18.0)
Requirement already satisfied: attrs>=17.4.0 in ./lib/python3.9/site-packages (from jsonschema==3.0.0->pds-doi-service) (21.2.0)
Requirement already satisfied: joblib in ./lib/python3.9/site-packages (from nltk==3.5->pds-doi-service) (1.0.1)
Requirement already satisfied: regex in ./lib/python3.9/site-packages (from nltk==3.5->pds-doi-service) (2021.9.24)
Requirement already satisfied: tqdm in ./lib/python3.9/site-packages (from nltk==3.5->pds-doi-service) (4.62.3)
Requirement already satisfied: isodate in ./lib/python3.9/site-packages (from openapi-schema-validator==0.1.4->pds-doi-service) (0.6.0)
Requirement already satisfied: jdcal in ./lib/python3.9/site-packages (from openpyxl==3.0->pds-doi-service) (1.4.1)
Requirement already satisfied: et_xmlfile in ./lib/python3.9/site-packages (from openpyxl==3.0->pds-doi-service) (1.1.0)
Requirement already satisfied: elementpath<3.0.0,>=2.1.2 in ./lib/python3.9/site-packages (from xmlschema==1.5.1->pds-doi-service) (2.3.2)
Requirement already satisfied: charset-normalizer~=2.0.0 in ./lib/python3.9/site-packages (from requests>=2.23->pds-doi-service) (2.0.6)
Installing collected packages: pds-doi-service
  Attempting uninstall: pds-doi-service
    Found existing installation: pds-doi-service 2.0.0
    Uninstalling pds-doi-service-2.0.0:
      Successfully uninstalled pds-doi-service-2.0.0
Successfully installed pds-doi-service-2.0.1
WARNING: You are using pip version 21.1.1; however, version 21.2.4 is available.

Can confirm that local database, transaction history and INI config are all maintained after the update. However, if this update had modified the database schema it would have required a rebuild of the database from scratch (i.e. calling pds-doi-init to pull existing entries from DataCite).

[jordanpadams]

@collinss-jpl do we have it documented how to upgrade? e.g. stop the service, run pip install, start the service?

[collinss-jpl]

@jordanpadams Not yet, so I'm only considering the "Test out" portion of this ticket to be completed, so it should be left open for now