Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozilla/remote-settings
Delivering data to Firefox
https://github.com/mozilla/remote-settings
product-delivery
Last synced: 5 days ago
JSON representation
Delivering data to Firefox
- Host: GitHub
- URL: https://github.com/mozilla/remote-settings
- Owner: mozilla
- License: apache-2.0
- Created: 2018-02-20T18:49:42.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T10:44:33.000Z (about 2 months ago)
- Last Synced: 2024-10-29T12:12:50.347Z (about 2 months ago)
- Topics: product-delivery
- Language: Python
- Homepage: https://remote-settings.readthedocs.io/
- Size: 14.1 MB
- Stars: 13
- Watchers: 15
- Forks: 12
- Open Issues: 28
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: docs/support.rst
Awesome Lists containing this project
- awesome - mozilla/remote-settings - Delivering data to Firefox (others)
README
Remote Settings
===============Remote Settings is a Mozilla service that makes it easy to manage evergreen settings data in Firefox. A simple API is available in Firefox for accessing the synchronized data.
https://remote-settings.readthedocs.io
--------------------------------------.. image:: https://img.shields.io/badge/Status-Sustain-green
Content
-------This *Remote Settings* repository contains the following files and directories of note:
* ``bin/``: container entry point and script(s)
* ``config/``: example configuration file(s)
* ``docs/``: documentation source files
* ``kinto-remote-settings/``: Kinto plugin specific to Remote Settings
* ``tests/``: browser/integration/gatekeeper tests
* ``pyproject.toml``: contains dependency information and (most) config settings
* ``VERSION``: SemVer version number that serves as both the version of the service and the ``kinto-remote-settings`` pluginSetup
-----You will need:
- Docker
- ``docker-compose`` with `buildkit `_ enabled
- `poetry `_
- `Make `_Usage
-----.. code-block:: shell
make start
Your *Remote Settings* instance is now ready at http://localhost:8888. See the `*Setup a Local Server* `_ tutorial for more details.
Test Locally
------------**Kinto Remote Settings Unit Tests**
To run unit tests, you need Postgres installed and a database ``testdb`` available. This can be created with:
.. code-block:: shell
make build-db
After this setup is complete, tests can be run with ``pytest`` using ``make``:
.. code-block:: shell
make test
**Browser Tests**
With Docker and docker-compose, test that all components are working as expected with:
.. code-block:: shell
make build
make browser-test.. note::
The ``docker-compose run web migrate`` command is only needed once, to prime the
PostgreSQL server (this is done automatically for you in the make command).
You can flush all the Kinto data in your local persistent PostgreSQL with
``curl -XPOST http://localhost:8888/v1/__flush__``That will start ``memcached``, ``postgresql``, ``autograph`` and Kinto (at ``web:8888``)
and lastly the ``tests`` container that primarily
uses ``pytest`` to test various things against ``http://web:8888/v1``.When you're done running the above command, the individual servers will still
be running and occupying those ports on your local network. When you're
finished, run:.. code-block:: shell
make stop
Test Remote Server
------------------Browser tests can be executed on a remote server or against the docker-compose containers.
To run the test suite, first build the tests container
.. code-block:: shell
docker-compose build tests
or download a pre-built container from `Dockerhub `_.
Next run the tests, supplying config values as necessary. Config values are
set as environment variables provided to the Docker container. See
``tests/conftest.py`` for descriptions of all of the config options that are
available.Note that the tests assume that the server has the ``attachments``,
``changes``, ``history``, and ``signer`` plugins enabled. It may optionally
have the ``email`` plugin installed.The credentials passed in ``SETUP_AUTH`` should have the permission to create users,
buckets, and collections. These credentials will be in the form
``SETUP_AUTH=username:password`` or ``SETUP_AUTH="Bearer some_token"``- All tests will run under the ``integration-tests`` collection in the ``main-workspace`` bucket
- If the collection does not exist it will be created
- There should be two users available
- one user should be added to the ``editors`` group of the available collection
- the other should be added to the ``reviewers`` group of the available collection
- the credentials of these users should be passed in the ``EDITOR_AUTH`` and
``REVIEWER_AUTH`` config options respectivelyRunning browser tests on the Remote Settings DEV server should look something like:
.. code-block:: shell
docker run --rm \
--env SERVER=https://remote-settings-dev.allizom.org/v1 \
--env MAIL_DIR="" `#disables test cases related to emails` \
--env EDITOR_AUTH= \
--env REVIEWER_AUTH= \
remotesettings/tests browser-testBecause the tests are capable of running against environments with existing data, there are limitations to what they can do. Examples:
- Test setup is global
- Test setup and may be partially skipped if the bucket, collection and users already exist
- All tests have access to the same bucket, collection, and users
- Tests are not allowed to delete the bucket(s), collection(s) or users
- Test collection records are purged before each test
- Test collection is expected to have one property named "title" and a required file attachmentDebugging Locally (simple)
--------------------------The simplest form of debugging is to run a suite of tests against the Kinto server:
.. code-block:: shell
make browser-test
Debugging Locally (advanced)
----------------------------Suppose you want to play with running the Kinto server, then go into
a ``bash`` session like this:.. code-block:: shell
docker-compose run --service-ports --user 0 web bash
Now you're ``root`` so you can do things like ``apt-get update && apt-get install jed``
to install tools and editors. Also, because of the ``--service-ports`` if you do
start a Kinto server on ``:8888`` it will be exposed from the host.For example, instead of starting Kinto with ``uwsgi`` you can start it
manually with ``kinto start``:.. code-block:: shell
kinto start --ini config/local.ini
Another thing you might want to debug is the ``tests`` container that tests
against the Kinto server... code-block:: shell
docker-compose run --rm tests bash
Now, from that ``bash`` session you can reach the other services like:
.. code-block:: shell
http http://autograph:8000/__heartbeat__
http http://web:8888/v1/__heartbeat__Upgrade Things
--------------Dependabot is enabled on this repository, so it should keep dependencies up to date.
To manually edit dependency versions, use `standard poetry commands `_. Because our
usecase is somewhat complex with multiple groups and some dependencies appearing
in multiple groups, sometimes the easiest way to update packages is to edit
``pyproject.toml`` to the specified package version, then run:.. code-block:: shell
poetry lock --no-update
to update the lockfile.
To test that this installs run:
.. code-block:: shell
make install
About versioning
----------------We respect `SemVer `_ here. However, the "public API" of this package is not the user-facing API of the service itself, but is considered to be the set of configuration and services that this package and its dependencies use. Accordingly, follow these rules:
* **MAJOR** must be incremented if a change on configuration, system, or third-party service is required, or if any of the dependencies has a major increment
* **MINOR** must be incremented if any of the dependencies has a minor increment
* **PATCH** must be incremented if no major nor minor increment is necessary.In other words, minor and patch versions are uncomplicated and can be deployed automatically, and major releases are very likely to require specific actions somewhere in the architecture.
Releasing
---------1. Go to project's releases on Github https://github.com/mozilla/remote-settings/releases
2. Publish a new release and tag ``vX.Y.Z``, using autogenerated changelog
3. Watch for deployment notifications in the Mozilla ``#kinto-standup`` Slack channel.In order to deploy to production:
1. Go to `deployment workflow page `_
2. Click on ``Run workflow``
3. Pick ``Branch=main``, ``Environment=prod``, ``ref=refs/tags/vX.Y.Z``, and click ``Run workflow``
4. Go to `deployment workflow page `_
5. Click on the latest ``prod`` run
6. Review pending deployments and click ``Approve and deploy``See `Environments `_ section for more details about deployments.