amo2kinto 1.7.2

Installation

To install the release:

pip install amo2kinto

To install the development environment:

make install

Importing blocklists from the addons server into Kinto

The addons-server is able to export its blocklists database in JSON.

The script will create the bucket/collection with a given schema.

The last version of the schema file can be find here: https://github.com/mozilla-services/amo-blocklist-ui/blob/master/amo-blocklist.json

You can use the make update-schemas command to fetch its last version.

You can use the json2kinto script to load this database into a Kinto server:

json2kinto --server http://localhost:8888/v1 \
           --addons-server https://addons.mozilla.org/  \
           --schema-file schemas.json

The script is able to synchronize (add new blocked items and remove old ones).

However if a blocked item already exists it won’t be altered.

json2kinto gives you the ability to configure what you want to load, with which user credentials and from which bucket and collection.

usage: json2kinto [-h] [--addons-server ADDONS_SERVER] [-s SERVER] [-a AUTH]
                  [-v] [-q] [-D] [-S SCHEMA_FILE] [--no-schema]
                  [--editor-auth EDITOR_AUTH]
                  [--reviewer-auth REVIEWER_AUTH]
                  [--certificates-bucket CERTIFICATES_BUCKET]
                  [--certificates-collection CERTIFICATES_COLLECTION]
                  [--gfx-bucket GFX_BUCKET] [--gfx-collection GFX_COLLECTION]
                  [--addons-bucket ADDONS_BUCKET]
                  [--addons-collection ADDONS_COLLECTION]
                  [--plugins-bucket PLUGINS_BUCKET]
                  [--plugins-collection PLUGINS_COLLECTION]
                  [-C] [-G] [-A] [-P]

Import the blocklists from the addons server into Kinto.

optional arguments:
  -h, --help            show this help message and exit
  --addons-server ADDONS_SERVER
                        The addons server to import from
  -s SERVER, --server SERVER
                        The location of the remote server (with prefix)
  -a AUTH, --auth AUTH  BasicAuth token:my-secret
  -v, --verbose         Show all messages.
  -q, --quiet           Show only critical errors.
  -D, --debug           Show all messages, including debug messages.
  -S SCHEMA_FILE, --schema-file SCHEMA_FILE
                        JSON Schemas file
  --no-schema           Should we handle schemas
  --editor-auth EDITOR_AUTH
                        Credentials to be used for requesting a review
  --reviewer-auth REVIEWER_AUTH
                        Credentials to be used for validating the review
  --certificates-bucket CERTIFICATES_BUCKET
                        Bucket name for certificates
  --certificates-collection CERTIFICATES_COLLECTION
                        Collection name for certificates
  --gfx-bucket GFX_BUCKET
                        Bucket name for gfx
  --gfx-collection GFX_COLLECTION
                        Collection name for gfx
  --addons-bucket ADDONS_BUCKET
                        Bucket name for addons
  --addons-collection ADDONS_COLLECTION
                        Collection name for addon
  --plugins-bucket PLUGINS_BUCKET
                        Bucket name for plugins
  --plugins-collection PLUGINS_COLLECTION
                        Collection name for plugin
  -C, --certificates    Only import certificates
  -G, --gfx             Only import GFX drivers
  -A, --addons          Only import addons
  -P, --plugins         Only import plugins

Generate a blocklist.xml file from Kinto collections

If you want to export blocklists stored in Kinto in the addons server XML export format, you can use the kinto2xml script:

kinto2xml -s http://localhost:8888/v1

kinto2xml gives you the ability to configure what you want to export and in which bucket and collection are the data stored.

usage: kinto2xml [-h] [-s SERVER] [-a AUTH] [-v] [-q] [-D]
                 [--certificates-bucket CERTIFICATES_BUCKET]
                 [--certificates-collection CERTIFICATES_COLLECTION]
                 [--gfx-bucket GFX_BUCKET] [--gfx-collection GFX_COLLECTION]
                 [--addons-bucket ADDONS_BUCKET]
                 [--addons-collection ADDONS_COLLECTION]
                 [--plugins-bucket PLUGINS_BUCKET]
                 [--plugins-collection PLUGINS_COLLECTION]
                 [--api-version API_VERSION] [--app APP]
                 [--app-version APP_VERSION] [-o OUT]

Build a blocklists.xml file from Kinto blocklists.

optional arguments:
  -h, --help            show this help message and exit
  -s SERVER, --server SERVER
                        The location of the remote server (with prefix)
  -a AUTH, --auth AUTH  BasicAuth token:my-secret
  -v, --verbose         Show all messages.
  -q, --quiet           Show only critical errors.
  -D, --debug           Show all messages, including debug messages.
  --certificates-bucket CERTIFICATES_BUCKET
                        Bucket name for certificates
  --certificates-collection CERTIFICATES_COLLECTION
                        Collection name for certificates
  --gfx-bucket GFX_BUCKET
                        Bucket name for gfx
  --gfx-collection GFX_COLLECTION
                        Collection name for gfx
  --addons-bucket ADDONS_BUCKET
                        Bucket name for addons
  --addons-collection ADDONS_COLLECTION
                        Collection name for addon
  --plugins-bucket PLUGINS_BUCKET
                        Bucket name for plugins
  --plugins-collection PLUGINS_COLLECTION
                        Collection name for plugin
  --api-version API_VERSION
                        Targeted blocklists.xml APP id
  --app APP             Targeted blocklists.xml APP id
  --app-version APP_VERSION
                        The targetted app version
  -o OUT, --out OUT     Output XML file.

Show differences between two XML files

Once you’ve imported the data and exported them, you may want to validate that both Kinto and addons server export the exact same data in XML.

You can use the xml-verifier command to validate that both files are rendered the same way.

The xml-verifier command accept both files path and files URLs.

APPID="{ec8030f7-c20a-464f-9b0e-13a3a9e97384}"
kinto2xml --app $APPID --app-version 46.0 -o generated-blocklists.xml
xml-verifier https://blocklist.addons.mozilla.org/blocklist/3/$APPID/46.0/ generated-blocklists.xml

Generate blocked addons and plugins description pages

You might want to export the human readable list and description of add-ons and plugins that were blocked.

You can do that using the blockpages-generator cli tool:

usage: blockpages-generator [-h] [-s SERVER] [-a AUTH] [-b BUCKET] [-v] [-q]
                            [-D] [--addons-collection ADDONS_COLLECTION]
                            [--plugins-collection PLUGINS_COLLECTION]
                            [-d TARGET_DIR]

Generate blocked item description files.

optional arguments:
  -h, --help            show this help message and exit
  -s SERVER, --server SERVER
                        The location of the remote server (with prefix)
  -a AUTH, --auth AUTH  BasicAuth token:my-secret
  -b BUCKET, --bucket BUCKET
                        Bucket name.
  -v, --verbose         Show all messages.
  -q, --quiet           Show only critical errors.
  -D, --debug           Show all messages, including debug messages.
  --addons-collection ADDONS_COLLECTION
                        Collection name for addon
  --plugins-collection PLUGINS_COLLECTION
                        Collection name for plugin
  -d TARGET_DIR, --target-dir TARGET_DIR
                        Destination directory to write files in.

It will generate an index.html file with the list of records present in the addons and plugins collections in the target-dir directory.

It will also generate a file per add-on and plugin using the blockID or the id. e.g i487.html or 08db5018-2c80-4c4d-aa98-dafe6aacc28c.html

1.7.2 (2017-02-20)

• Fix XML exporter on missing blockID. (#63)

1.7.1 (2016-11-24)

Bug fix

• Allow the importer to work even without the permission to create collections. (#56)

• Use PUT instead of PATCH to fully overwrite the destination with the source (#58)

1.7.0 (2016-11-21)

New features

• Retry downloading the XML in case it fails the first time. (#50)

Bug fix

• Remove redundant footer when generating pages. (#51)

• Allow the importer to work even without the permission to create buckets. (#53)

Internal changes

• Improve the way the Makefile works (#52)

1.6.0 (2016-10-04)

New features

• Add a configurable signoff workflow to-review → to-sign (#48)

1.5.1 (2016-09-08)

Bug fix

• session_kwargs is not accessible anymore with last kinto-http client release. (#45)

1.5.0 (2016-08-25)

• Add the blockpages-generator CLI tool (#43)

1.4.1 (2016-08-02)

• Fix blockID ordering to make it the same as the addons-server.

1.4.0 (2016-07-18)

New features

• Add version ranges for GFX items (#39) — Bug 1283601

1.3.1 (2016-07-06)

Bug fix

• Fix patch_records properties.

1.3.0 (2016-07-06)

• Update records that were changed (#37)

1.2.1 (2016-05-26)

Bug fix

• kinto_client.delete_records API changed. (#35)

1.2.0 (2016-05-26)

New features

• Let people specify --app-version and --api-version while using kinto2xml (#33)

• Add functional tests for both version of the XML file format. (#33)

• Configure the kinto-admin as well as the JSONSchema (#32)

Bug fix

• Group addons by the biggest guid (#33)

1.1.0 (2016-05-18)

Bug fix

• In case there is a diff using xml-verifier, the command now returns an error code (#28)

Internal changes

• json2kinto does not set destination collections as publicly readable (#27)

1.0.0 (2016-05-12)

Breaking changes

• kinto2xml was renamed amo2kinto (#21)

• New JSON Schema file format with a “collection” prefix (#22)

New features

• Use the schema to validate AMO records in the importer script. (#5)

• Warn if the server does not have the schema capability (#24)

Internal changes

• Document amo2kinto commands: json2kinto, kinto2xml and verifier. (#23)

0.1.0 (2016-04-27)

Initial version

• Create collection with the definition of the JSON schema.

• Fetch AMO blocklists information from the /blocked/blocklists.json AMO endpoint.

• Handle import configuration on the CLI. - Bucket / Collection names - Remote AMO endpoint configuration - Schema file path configuration - Schema or not schema - Verbosity level - Server selection - Auth credentials - Importation type selection

• Support for kinto-signer triggering

• Full SSL support for Python 2.7

• Full Python 2.7 and Python 3.4/3.5 support

• Handle the enabled flag to activate records

• Makefile rule to update the schema definition

• Export kinto blocklists in XML blocklist file version 2

• Export kinto blocklists in XML blocklist file version 3

• XML verifier that create a diff of two XML files