├── fpdc ├── __init__.py ├── common │ ├── __init__.py │ ├── management │ │ ├── __init__.py │ │ └── commands │ │ │ ├── __init__.py │ │ │ └── add_permission.py │ ├── migrations │ │ └── __init__.py │ └── apps.py ├── components │ ├── __init__.py │ ├── migrations │ │ ├── __init__.py │ │ ├── 0001_initial.py │ │ ├── 0002_modules.py │ │ └── 0003_container.py │ ├── apps.py │ ├── serializers.py │ ├── views.py │ ├── models.py │ └── tests │ │ ├── test_serializers.py │ │ ├── test_models.py │ │ └── test_views.py ├── releases │ ├── __init__.py │ ├── tests │ │ ├── __init__.py │ │ ├── test_serializers.py │ │ ├── test_models.py │ │ └── test_views.py │ ├── migrations │ │ ├── __init__.py │ │ └── 0001_initial.py │ ├── apps.py │ ├── serializers.py │ ├── views.py │ └── models.py ├── settings │ ├── __init__.py │ ├── test.py │ ├── prod.py │ └── base.py ├── templates │ └── rest_framework │ │ └── api.html ├── wsgi.py ├── oidc_backend.py └── urls.py ├── .cico.pipeline ├── pyproject.toml ├── .s2iignore ├── pytest.ini ├── .s2i └── environment ├── .coveragerc ├── requirements.txt ├── .gitignore ├── Dockerfile ├── requirements-dev.txt ├── run-container.sh ├── README.md ├── .licenses_strategy.ini ├── examples └── create_release.py ├── manage.py ├── Makefile ├── tox.ini ├── CONTRIBUTING.md ├── DEVELOPING.md └── LICENSE /fpdc/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/common/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/components/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/releases/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/settings/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/releases/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.cico.pipeline: -------------------------------------------------------------------------------- 1 | fedoraInfraTox { } 2 | -------------------------------------------------------------------------------- /fpdc/common/management/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/common/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/components/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/releases/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /fpdc/common/management/commands/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 100 3 | -------------------------------------------------------------------------------- /.s2iignore: -------------------------------------------------------------------------------- 1 | .tox 2 | .git 3 | build 4 | dist 5 | *.egg-info 6 | venv 7 | .venv 8 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | DJANGO_SETTINGS_MODULE = fpdc.settings.test 3 | addopts = --nomigrations --cov=. 4 | -------------------------------------------------------------------------------- /fpdc/common/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class CommonConfig(AppConfig): 5 | name = "common" 6 | -------------------------------------------------------------------------------- /fpdc/releases/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class ReleasesConfig(AppConfig): 5 | name = "releases" 6 | -------------------------------------------------------------------------------- /fpdc/components/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class ComponentsConfig(AppConfig): 5 | name = "components" 6 | -------------------------------------------------------------------------------- /fpdc/settings/test.py: -------------------------------------------------------------------------------- 1 | from .base import * # NOQA 2 | 3 | DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}} 4 | -------------------------------------------------------------------------------- /.s2i/environment: -------------------------------------------------------------------------------- 1 | DISABLE_MIGRATE=1 2 | UPGRADE_PIP_TO_LATEST=1 3 | APP_MODULE=fpdc.wsgi:application 4 | OPENSHIFT_CONFIG_DIR=/opt/app-root/config 5 | OPENSHIFT_APP_DNS=* 6 | -------------------------------------------------------------------------------- /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | omit = 3 | .venv/* 4 | *apps.py, 5 | *migrations/*, 6 | *settings*, 7 | *tests/*, 8 | *urls.py, 9 | *wsgi.py, 10 | manage.py, 11 | .tox/*, 12 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | django >= 1.11.22 2 | djangorestframework >= 3.9.1 3 | django-computed-property 4 | psycopg2-binary 5 | gunicorn 6 | whitenoise 7 | mozilla-django-oidc >= 1.1.2 8 | coreapi 9 | pygments 10 | markdown 11 | -------------------------------------------------------------------------------- /fpdc/releases/serializers.py: -------------------------------------------------------------------------------- 1 | from rest_framework.serializers import ModelSerializer 2 | 3 | from fpdc.releases.models import Release 4 | 5 | 6 | class ReleaseSerializer(ModelSerializer): 7 | class Meta: 8 | model = Release 9 | fields = "__all__" 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | #python + virtual environment 2 | .venv 3 | __pycache__ 4 | .coverage 5 | .pytest_cache 6 | .tox 7 | 8 | #sqlite db 9 | db.sqlite3 10 | 11 | #VS Code 12 | .vscode 13 | 14 | #local runtime settings 15 | .env 16 | 17 | #oidc secret file 18 | client_secrets.json 19 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM fedora:latest 2 | 3 | WORKDIR /code 4 | 5 | ENV PYTHONPATH=/code 6 | 7 | ADD requirements.txt /tmp 8 | 9 | RUN dnf -y install postgresql\ 10 | && dnf clean all\ 11 | && pip3 install -r /tmp/requirements.txt 12 | 13 | ENTRYPOINT ["/code/run-container.sh"] 14 | -------------------------------------------------------------------------------- /fpdc/templates/rest_framework/api.html: -------------------------------------------------------------------------------- 1 | {% extends "rest_framework/base.html" %} 2 | 3 | {% block title %} Fedora Product Definition Center {% endblock %} 4 | 5 | {% block branding %} 6 | 7 | 8 | Fedora Product Definition Center 9 | 10 | 11 | {% endblock %} 12 | -------------------------------------------------------------------------------- /fpdc/wsgi.py: -------------------------------------------------------------------------------- 1 | """ 2 | WSGI config for fpdc project. 3 | 4 | It exposes the WSGI callable as a module-level variable named ``application``. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ 8 | """ 9 | 10 | import os 11 | 12 | from django.core.wsgi import get_wsgi_application 13 | 14 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fpdc.settings.prod") 15 | 16 | application = get_wsgi_application() 17 | -------------------------------------------------------------------------------- /requirements-dev.txt: -------------------------------------------------------------------------------- 1 | -r requirements.txt 2 | black 3 | flake8 4 | pytest 5 | pytest-cov 6 | pytest-django 7 | mixer 8 | tox 9 | freezegun 10 | # Install python-fedora that support fpdc-client 11 | -e git://github.com/fedora-infra/python-fedora.git@9bfb521069550e4502951f58d599a6852b12c0e1#egg=python-fedora 12 | # Install oidc-register v0.2 13 | -e git://github.com/puiterwijk/oidc-register.git@170278046cea33fac81dfd4a34d9829827eb8973#egg=oidc-register 14 | fpdc-client 15 | -------------------------------------------------------------------------------- /run-container.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | echo ">> Waiting for postgres to start" 4 | WAIT=0 5 | while ! psql -h 127.0.0.1 postgres postgres -c "select 1"; do 6 | sleep 1 7 | WAIT=$(($WAIT + 1)) 8 | if [ "$WAIT" -gt 15 ]; then 9 | echo "Error: Timeout wating for Postgres to start" 10 | exit 1 11 | fi 12 | done 13 | 14 | django-admin migrate 15 | echo "The server is now available at http://127.0.0.1:8000" 16 | django-admin runserver 0.0.0.0:8000 17 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fpdc 2 | > Fedora Product Definition Center 3 | 4 | This application aims to provide a single source of truth for the data used during the Fedora distribution release process 5 | 6 | ## Contributing 7 | 8 | To get started contributing content, see the [Contributing 9 | guide](https://github.com/fedora-infra/fpdc/blob/master/CONTRIBUTING.md), 10 | To setup your development environment, see the [Developing guide](https://github.com/fedora-infra/fpdc/blob/master/DEVELOPING.md) 11 | -------------------------------------------------------------------------------- /.licenses_strategy.ini: -------------------------------------------------------------------------------- 1 | [Licenses] 2 | authorized_licenses: 3 | bsd 4 | new bsd 5 | simplified bsd 6 | apache 7 | apache 2.0 8 | apache software 9 | gnu lgpl 10 | gpl v2 11 | gpl v3 12 | lgpl with exceptions or zpl 13 | isc 14 | isc license (iscl) 15 | mit 16 | python software foundation 17 | zpl 2.1 18 | GNU Library or Lesser General Public License (LGPL) 19 | LGPL with exceptions or ZPL 20 | Zope Public 21 | MPL-2.0 22 | MPL 2.0 23 | -------------------------------------------------------------------------------- /examples/create_release.py: -------------------------------------------------------------------------------- 1 | from fpdc_client import FPDC, Release 2 | 3 | server = FPDC(url="http://localhost:8000") 4 | server.connect() 5 | 6 | # Use oidc-register to get a client_secret.json file 7 | server.login(auth_file="client_secrets.json") 8 | new_release = Release.create( 9 | { 10 | "release_id": "fedora-42", 11 | "short": "f42", 12 | "version": "42", 13 | "name": "Fedora", 14 | "release_date": "2042-01-01", 15 | "eol_date": "2042-12-31", 16 | "sigkey": "towel", 17 | } 18 | ) 19 | 20 | releases = Release.all() 21 | for release in releases: 22 | print(release) 23 | -------------------------------------------------------------------------------- /fpdc/oidc_backend.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | from django.contrib.auth.models import Group 3 | from mozilla_django_oidc.auth import OIDCAuthenticationBackend 4 | 5 | 6 | class FpdcOIDCAuthenticationBackend(OIDCAuthenticationBackend): 7 | def create_user(self, claims): 8 | """ 9 | Custom create_user method that sync the FAS releng-team member 10 | with the internal FPDC releng-group. 11 | """ 12 | user = super(FpdcOIDCAuthenticationBackend, self).create_user(claims) 13 | 14 | if settings.FAS_GROUP in claims.get("groups", ""): 15 | releng_group, created = Group.objects.get_or_create(name="releng-team") 16 | releng_group.user_set.add(user) 17 | 18 | return user 19 | -------------------------------------------------------------------------------- /fpdc/components/serializers.py: -------------------------------------------------------------------------------- 1 | from rest_framework.serializers import ModelSerializer, URLField 2 | 3 | from fpdc.components.models import RPMPackage, Module, Container 4 | 5 | 6 | class RPMPackageSerializer(ModelSerializer): 7 | dist_git_url = URLField(required=False, max_length=200) 8 | 9 | class Meta: 10 | model = RPMPackage 11 | fields = "__all__" 12 | 13 | 14 | class ModuleSerializer(ModelSerializer): 15 | dist_git_url = URLField(required=False, max_length=200) 16 | 17 | class Meta: 18 | model = Module 19 | fields = "__all__" 20 | 21 | 22 | class ContainerSerializer(ModelSerializer): 23 | dist_git_url = URLField(required=False, max_length=200) 24 | 25 | class Meta: 26 | model = Container 27 | fields = "__all__" 28 | -------------------------------------------------------------------------------- /fpdc/components/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Generated by Django 1.11.18 on 2019-02-01 13:39 3 | from __future__ import unicode_literals 4 | 5 | from django.db import migrations, models 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | initial = True 11 | 12 | dependencies = [] 13 | 14 | operations = [ 15 | migrations.CreateModel( 16 | name="RPMPackage", 17 | fields=[ 18 | ( 19 | "id", 20 | models.AutoField( 21 | auto_created=True, primary_key=True, serialize=False, verbose_name="ID" 22 | ), 23 | ), 24 | ("name", models.CharField(max_length=255, unique=True)), 25 | ("point_of_contact", models.CharField(max_length=100)), 26 | ], 27 | ) 28 | ] 29 | -------------------------------------------------------------------------------- /fpdc/components/migrations/0002_modules.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Generated by Django 1.11.18 on 2019-02-06 10:21 3 | from __future__ import unicode_literals 4 | 5 | from django.db import migrations, models 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | dependencies = [("components", "0001_initial")] 11 | 12 | operations = [ 13 | migrations.CreateModel( 14 | name="Module", 15 | fields=[ 16 | ( 17 | "id", 18 | models.AutoField( 19 | auto_created=True, primary_key=True, serialize=False, verbose_name="ID" 20 | ), 21 | ), 22 | ("name", models.CharField(max_length=255, unique=True)), 23 | ("point_of_contact", models.CharField(max_length=100)), 24 | ], 25 | ) 26 | ] 27 | -------------------------------------------------------------------------------- /fpdc/components/migrations/0003_container.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Generated by Django 1.11.18 on 2019-02-06 13:34 3 | from __future__ import unicode_literals 4 | 5 | from django.db import migrations, models 6 | 7 | 8 | class Migration(migrations.Migration): 9 | 10 | dependencies = [("components", "0002_modules")] 11 | 12 | operations = [ 13 | migrations.CreateModel( 14 | name="Container", 15 | fields=[ 16 | ( 17 | "id", 18 | models.AutoField( 19 | auto_created=True, primary_key=True, serialize=False, verbose_name="ID" 20 | ), 21 | ), 22 | ("name", models.CharField(max_length=255, unique=True)), 23 | ("point_of_contact", models.CharField(max_length=100)), 24 | ], 25 | ) 26 | ] 27 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fpdc.settings.base") 7 | try: 8 | from django.core.management import execute_from_command_line 9 | except ImportError: 10 | # The above import may fail for some other reason. Ensure that the 11 | # issue is really that Django is missing to avoid masking other 12 | # exceptions on Python 2. 13 | try: 14 | import django 15 | except ImportError: 16 | raise ImportError( 17 | "Couldn't import Django. Are you sure it's installed and " 18 | "available on your PYTHONPATH environment variable? Did you " 19 | "forget to activate a virtual environment?" 20 | ) 21 | raise 22 | execute_from_command_line(sys.argv) 23 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | include .env 2 | 3 | build: 4 | sudo podman build -t fpdc-web $(CURDIR) 5 | 6 | down: 7 | sudo podman pod rm -f fpdc-dev 8 | 9 | logs-db: 10 | sudo podman logs database 11 | 12 | logs-web: 13 | sudo podman logs fpdc-web 14 | 15 | ps: 16 | sudo podman ps -pa 17 | 18 | prune: 19 | sudo podman volume rm -f pgdata 20 | 21 | up: 22 | sudo podman pod create --name fpdc-dev 23 | sudo podman run --name fpdc-web --net=host --pod fpdc-dev -dt -e OIDC_RP_CLIENT_ID=$(OIDC_RP_CLIENT_ID) -e OIDC_RP_CLIENT_SECRET=$(OIDC_RP_CLIENT_SECRET) -e DJANGO_SETTINGS_MODULE=fpdc.settings.base -v $(CURDIR):/code fpdc-web 24 | sudo podman run --name database --net=host --pod fpdc-dev -dt -e PGDATA=/var/lib/postgresql/data/pgdata -v pgdata:/var/lib/postgresql/data/pgdata postgres 25 | 26 | shell: 27 | sudo podman exec -it fpdc-web bash 28 | 29 | start: 30 | sudo podman pod start fpdc-dev 31 | 32 | stop: 33 | sudo podman pod stop fpdc-dev 34 | -------------------------------------------------------------------------------- /fpdc/releases/tests/test_serializers.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | from fpdc.releases.serializers import ReleaseSerializer 4 | from mixer.backend.django import mixer 5 | 6 | 7 | class ReleaseSerializerTests(TestCase): 8 | def test_serialize(self): 9 | release = mixer.blend("releases.Release") 10 | serializer = ReleaseSerializer(release) 11 | assert serializer.data["short"] == release.short 12 | assert serializer.data["version"] == release.version 13 | 14 | def test_deserialize_invalid(self): 15 | serializer = ReleaseSerializer(data={"release_id": None, "short": "short-name"}) 16 | assert serializer.is_valid() is False 17 | 18 | def test_calculated_fields(self): 19 | release = mixer.blend("releases.Release", eol_date="2017-01-01") 20 | serializer = ReleaseSerializer(release) 21 | assert serializer.data["status"] == "eol" 22 | assert serializer.data["active"] is False 23 | -------------------------------------------------------------------------------- /fpdc/components/views.py: -------------------------------------------------------------------------------- 1 | from rest_framework import viewsets 2 | from rest_framework import filters 3 | 4 | from fpdc.components.models import RPMPackage, Module, Container 5 | from fpdc.components.serializers import RPMPackageSerializer, ModuleSerializer, ContainerSerializer 6 | 7 | 8 | class RPMPackageViewSet(viewsets.ModelViewSet): 9 | queryset = RPMPackage.objects.all() 10 | serializer_class = RPMPackageSerializer 11 | filter_backends = (filters.OrderingFilter,) 12 | ordering_fields = "__all__" 13 | 14 | 15 | class ModuleViewSet(viewsets.ModelViewSet): 16 | queryset = Module.objects.all() 17 | serializer_class = ModuleSerializer 18 | filter_backends = (filters.OrderingFilter,) 19 | ordering_fields = "__all__" 20 | 21 | 22 | class ContainerViewSet(viewsets.ModelViewSet): 23 | queryset = Container.objects.all() 24 | serializer_class = ContainerSerializer 25 | filter_backends = (filters.OrderingFilter,) 26 | ordering_fields = "__all__" 27 | -------------------------------------------------------------------------------- /fpdc/releases/views.py: -------------------------------------------------------------------------------- 1 | from rest_framework import viewsets 2 | from rest_framework import filters 3 | 4 | from fpdc.releases.models import Release 5 | from fpdc.releases.serializers import ReleaseSerializer 6 | 7 | 8 | class ReleaseViewSet(viewsets.ModelViewSet): 9 | queryset = Release.objects.all() 10 | serializer_class = ReleaseSerializer 11 | filter_backends = (filters.OrderingFilter,) 12 | ordering_fields = "__all__" 13 | ordering = ("-version",) # Descending ordering on version higher version first. 14 | 15 | def get_queryset(self): 16 | """ 17 | Optionally restricts the returned Release to only active releases, 18 | by filtering against a `active` query parameter in the URL. 19 | """ 20 | queryset = Release.objects.all() 21 | active = self.request.query_params.get("active", None) 22 | if active is not None: 23 | queryset = queryset.filter(active=active.title()) 24 | 25 | return queryset 26 | -------------------------------------------------------------------------------- /fpdc/common/management/commands/add_permission.py: -------------------------------------------------------------------------------- 1 | from django.core.management.base import BaseCommand 2 | from django.contrib.auth.models import Group, ContentType 3 | 4 | 5 | class Command(BaseCommand): 6 | help = "Sets the required permission to add, change or delete a resource" 7 | 8 | def add_arguments(self, parser): 9 | parser.add_argument("fas_group", type=str) 10 | parser.add_argument("resource", type=str, help="name of a resource, ie release") 11 | 12 | def handle(self, *args, **options): 13 | 14 | resource = ContentType.objects.get(app_label=options["resource"]) 15 | permissions = list(resource.permission_set.all()) 16 | group, created = Group.objects.get_or_create(name=options["fas_group"]) 17 | for permission in permissions: 18 | group.permissions.add(permission) 19 | 20 | self.stdout.write( 21 | self.style.SUCCESS( 22 | f"{options['fas_group']} succesfully added to {options['resource']} permissions" 23 | ) 24 | ) 25 | -------------------------------------------------------------------------------- /fpdc/releases/models.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | 3 | import computed_property 4 | from django.db import models 5 | 6 | 7 | class Release(models.Model): 8 | release_id = models.CharField(max_length=255, blank=False, unique=True) 9 | short = models.CharField(max_length=255, blank=False, unique=False) 10 | version = models.IntegerField(blank=False) 11 | name = models.CharField(max_length=255, blank=False, unique=False) 12 | release_date = models.DateField() 13 | eol_date = models.DateField() 14 | sigkey = models.CharField(max_length=255, blank=False) 15 | status = computed_property.ComputedCharField(compute_from="_status", max_length=255, null=True) 16 | active = computed_property.ComputedBooleanField(compute_from="_active", default=True) 17 | 18 | def _status(self): 19 | if self.release_date > datetime.date.today(): 20 | return "development" 21 | if self.eol_date < datetime.date.today(): 22 | return "eol" 23 | return "ga" 24 | 25 | def _active(self): 26 | return self.status == "ga" 27 | -------------------------------------------------------------------------------- /fpdc/components/models.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | from django.db import models 3 | 4 | 5 | class RPMPackage(models.Model): 6 | name = models.CharField(max_length=255, blank=False, unique=True) 7 | point_of_contact = models.CharField(max_length=100, blank=False) 8 | 9 | @property 10 | def dist_git_url(self): 11 | return settings.DIST_GIT_URL.format(namespace="rpms", name=self.name) 12 | 13 | 14 | class Module(models.Model): 15 | name = models.CharField(max_length=255, blank=False, unique=True) 16 | point_of_contact = models.CharField(max_length=100, blank=False) 17 | 18 | @property 19 | def dist_git_url(self): 20 | return settings.DIST_GIT_URL.format(namespace="modules", name=self.name) 21 | 22 | 23 | class Container(models.Model): 24 | name = models.CharField(max_length=255, blank=False, unique=True) 25 | point_of_contact = models.CharField(max_length=100, blank=False) 26 | 27 | @property 28 | def dist_git_url(self): 29 | return settings.DIST_GIT_URL.format(namespace="container", name=self.name) 30 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = lint, format, py36, licenses, django-migrations, bandit 3 | skipsdist = True 4 | 5 | [testenv] 6 | deps = 7 | -rrequirements-dev.txt 8 | commands = 9 | pytest 10 | passenv = HOME 11 | 12 | [testenv:lint] 13 | deps = 14 | flake8 > 3.0 15 | radon 16 | commands = 17 | python3 -m flake8 {posargs} 18 | 19 | [testenv:format] 20 | deps = 21 | black 22 | commands = 23 | python3 -m black --check {posargs:.} 24 | 25 | [testenv:licenses] 26 | deps = 27 | -rrequirements-dev.txt 28 | liccheck 29 | commands = 30 | liccheck -s .licenses_strategy.ini -r requirements.txt 31 | 32 | [testenv:django-migrations] 33 | deps = 34 | -rrequirements.txt 35 | commands = 36 | python manage.py makemigrations --settings fpdc.settings.test --check 37 | 38 | [testenv:bandit] 39 | deps = bandit 40 | commands = 41 | bandit -r fpdc/ -x fpdc/releases/tests/ -ll 42 | 43 | [flake8] 44 | radon-max-cc = 20 45 | show-source = True 46 | max-line-length = 100 47 | ignore = E203,W503 48 | exclude = .git,.tox,dist,*egg,.venv,manage.py,*settings.py 49 | -------------------------------------------------------------------------------- /fpdc/settings/prod.py: -------------------------------------------------------------------------------- 1 | import os 2 | import json 3 | from .base import * # NOQA 4 | 5 | # Directory where the configmap is monted in openshift 6 | CONFIG_DIR = os.environ.get("OPENSHIFT_CONFIG_DIR", BASE_DIR) # NOQA 7 | DEBUG = False 8 | 9 | ALLOWED_HOSTS = [os.environ.get("OPENSHIFT_APP_DNS")] 10 | 11 | with open(os.path.join(CONFIG_DIR, "config.json")) as fp: 12 | data = json.load(fp) 13 | 14 | SECRET_KEY = data["SECRET_KEY"] 15 | DATABASES = { 16 | "default": { 17 | "ENGINE": "django.db.backends.postgresql", 18 | "NAME": "fpdc", 19 | "USER": "fpdc", 20 | "PASSWORD": data["DB_PASSWORD"], 21 | "HOST": data["DB_HOST"], 22 | "PORT": "", 23 | } 24 | } 25 | 26 | # OIDC Settings 27 | OIDC_OP_JWKS_ENDPOINT = data["OIDC_OP_JWKS_ENDPOINT"] 28 | OIDC_RP_CLIENT_ID = data["OIDC_RP_CLIENT_ID"] 29 | OIDC_RP_CLIENT_SECRET = data["OIDC_RP_CLIENT_SECRET"] 30 | OIDC_OP_AUTHORIZATION_ENDPOINT = data["OIDC_OP_AUTHORIZATION_ENDPOINT"] 31 | OIDC_OP_TOKEN_ENDPOINT = data["OIDC_OP_TOKEN_ENDPOINT"] 32 | OIDC_OP_USER_ENDPOINT = data["OIDC_OP_USER_ENDPOINT"] 33 | 34 | # COREAPI URL 35 | COREAPI_URL = data["COREAPI_URL"] 36 | 37 | # Dist Git URL 38 | DIST_GIT_URL = data["DIST_GIT_URL"] 39 | -------------------------------------------------------------------------------- /fpdc/releases/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Generated by Django 1.11 on 2018-09-26 03:24 3 | from __future__ import unicode_literals 4 | 5 | import computed_property.fields 6 | from django.db import migrations, models 7 | 8 | 9 | class Migration(migrations.Migration): 10 | 11 | initial = True 12 | 13 | dependencies = [] 14 | 15 | operations = [ 16 | migrations.CreateModel( 17 | name="Release", 18 | fields=[ 19 | ( 20 | "id", 21 | models.AutoField( 22 | auto_created=True, primary_key=True, serialize=False, verbose_name="ID" 23 | ), 24 | ), 25 | ("release_id", models.CharField(max_length=255, unique=True)), 26 | ("short", models.CharField(max_length=255)), 27 | ("version", models.IntegerField()), 28 | ("name", models.CharField(max_length=255)), 29 | ("release_date", models.DateField()), 30 | ("eol_date", models.DateField()), 31 | ("sigkey", models.CharField(max_length=255)), 32 | ( 33 | "status", 34 | computed_property.fields.ComputedCharField( 35 | compute_from="_status", editable=False, max_length=255, null=True 36 | ), 37 | ), 38 | ( 39 | "active", 40 | computed_property.fields.ComputedBooleanField( 41 | compute_from="_active", default=True, editable=False 42 | ), 43 | ), 44 | ], 45 | ) 46 | ] 47 | -------------------------------------------------------------------------------- /fpdc/releases/tests/test_models.py: -------------------------------------------------------------------------------- 1 | from datetime import date 2 | 3 | import pytest 4 | from django.test import TestCase 5 | from freezegun import freeze_time 6 | from mixer.backend.django import mixer 7 | 8 | from fpdc.releases.models import Release 9 | 10 | pytestmark = pytest.mark.django_db 11 | 12 | 13 | class ReleaseTests(TestCase): 14 | def test_create(self): 15 | """Ensure we can create an instance of Release.""" 16 | mixer.blend(Release) 17 | assert Release.objects.count() == 1 18 | 19 | def test_query(self): 20 | """Ensure we can query for instances.""" 21 | mixer.blend(Release, short="fedora") 22 | r = Release.objects.get(short__exact="fedora") 23 | assert r.short == "fedora" 24 | 25 | @freeze_time("2018-06-01") 26 | def test_calculated_fields_is_eol(self): 27 | """Ensure we can query calculated fields.""" 28 | mixer.blend(Release, eol_date=date(2018, 5, 29), release_date=date(2017, 7, 11)) 29 | r = Release.objects.get(status__exact="eol") 30 | assert r.status == "eol" 31 | assert r.active is False 32 | 33 | @freeze_time("2018-05-01") 34 | def test_calculated_fields_is_ga(self): 35 | """Ensure we can query calculated fields.""" 36 | mixer.blend(Release, eol_date=date(2018, 5, 29), release_date=date(2017, 7, 11)) 37 | r = Release.objects.get(status__exact="ga") 38 | assert r.status == "ga" 39 | assert r.active is True 40 | 41 | @freeze_time("2017-06-01") 42 | def test_calculated_fields_is_development(self): 43 | """Ensure we can query calculated fields.""" 44 | mixer.blend(Release, eol_date=date(2018, 5, 29), release_date=date(2017, 7, 11)) 45 | r = Release.objects.get(status__exact="development") 46 | assert r.status == "development" 47 | assert r.active is False 48 | -------------------------------------------------------------------------------- /fpdc/urls.py: -------------------------------------------------------------------------------- 1 | """fpdc URL Configuration 2 | 3 | The `urlpatterns` list routes URLs to views. For more information please see: 4 | https://docs.djangoproject.com/en/1.11/topics/http/urls/ 5 | Examples: 6 | Function views 7 | 1. Add an import: from my_app import views 8 | 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') 9 | Class-based views 10 | 1. Add an import: from other_app.views import Home 11 | 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') 12 | Including another URLconf 13 | 1. Import the include() function: from django.conf.urls import url, include 14 | 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) 15 | """ 16 | from django.conf import settings 17 | from django.conf.urls import url, include 18 | 19 | from rest_framework.routers import DefaultRouter 20 | from rest_framework.documentation import include_docs_urls 21 | from rest_framework.schemas import get_schema_view 22 | 23 | from fpdc.releases.views import ReleaseViewSet 24 | from fpdc.components.views import RPMPackageViewSet, ModuleViewSet, ContainerViewSet 25 | 26 | schemaview = get_schema_view(title="Fedora Product Definition Center", url=settings.COREAPI_URL) 27 | 28 | router = DefaultRouter(trailing_slash=False) 29 | 30 | router.register(r"release", ReleaseViewSet) 31 | router.register(r"rpms", RPMPackageViewSet) 32 | router.register(r"modules", ModuleViewSet) 33 | router.register(r"containers", ContainerViewSet) 34 | 35 | urlpatterns = [ 36 | url(r"^oidc/", include("mozilla_django_oidc.urls")), 37 | url(r"^api/v1/", include((router.urls, "releases"), namespace="v1")), 38 | url(r"^api/v1/", include((router.urls, "rpms"), namespace="v1")), 39 | url(r"^api/v1/", include((router.urls, "modules"), namespace="v1")), 40 | url(r"^api/v1/", include((router.urls, "containers"), namespace="v1")), 41 | url(r"^docs/", include_docs_urls(title="Fedora Product Definition Center")), 42 | url(r"^$", schemaview), 43 | ] 44 | -------------------------------------------------------------------------------- /fpdc/components/tests/test_serializers.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | from fpdc.components.serializers import RPMPackageSerializer, ModuleSerializer, ContainerSerializer 4 | from mixer.backend.django import mixer 5 | 6 | 7 | class RPMPackageSerializerTests(TestCase): 8 | def test_serialize(self): 9 | rpm = mixer.blend("components.RPMPackage") 10 | serializer = RPMPackageSerializer(rpm) 11 | assert serializer.data["name"] == rpm.name 12 | assert serializer.data["point_of_contact"] == rpm.point_of_contact 13 | assert serializer.data["dist_git_url"] == rpm.dist_git_url 14 | 15 | def test_deserialize_invalid(self): 16 | serializer = RPMPackageSerializer(data={"rpmpackage_id": None, "name": "name"}) 17 | assert serializer.is_valid() is False 18 | 19 | 20 | class ModuleSerializerTests(TestCase): 21 | def test_serialize(self): 22 | module = mixer.blend("components.Module") 23 | serializer = ModuleSerializer(module) 24 | assert serializer.data["name"] == module.name 25 | assert serializer.data["point_of_contact"] == module.point_of_contact 26 | assert serializer.data["dist_git_url"] == module.dist_git_url 27 | 28 | def test_deserialize_invalid(self): 29 | serializer = ModuleSerializer(data={"module_id": None, "name": "name"}) 30 | assert serializer.is_valid() is False 31 | 32 | 33 | class ContainerSerializerTests(TestCase): 34 | def test_serialize(self): 35 | container = mixer.blend("components.Container") 36 | serializer = ContainerSerializer(container) 37 | assert serializer.data["name"] == container.name 38 | assert serializer.data["point_of_contact"] == container.point_of_contact 39 | assert serializer.data["dist_git_url"] == container.dist_git_url 40 | 41 | def test_deserialize_invalid(self): 42 | serializer = ContainerSerializer(data={"module_id": None, "name": "name"}) 43 | assert serializer.is_valid() is False 44 | -------------------------------------------------------------------------------- /fpdc/components/tests/test_models.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | from mixer.backend.django import mixer 3 | 4 | from fpdc.components.models import RPMPackage, Module, Container 5 | 6 | 7 | class RPMPackageTest(TestCase): 8 | def test_create(self): 9 | """Ensure we can create an instance of RPMPackage.""" 10 | mixer.blend(RPMPackage) 11 | assert RPMPackage.objects.count() == 1 12 | 13 | def test_query(self): 14 | """Ensure we can query for instances.""" 15 | mixer.blend(RPMPackage, name="firefox") 16 | r = RPMPackage.objects.get(name__exact="firefox") 17 | assert r.name == "firefox" 18 | 19 | def test_dist_git_url(self): 20 | """ Ensure the dist_git_url field is properly computed """ 21 | mixer.blend(RPMPackage, name="firefox") 22 | r = RPMPackage.objects.get(name__exact="firefox") 23 | assert r.dist_git_url == "https://src.fedoraproject.org/rpms/firefox" 24 | 25 | 26 | class ModulesTest(TestCase): 27 | def test_create(self): 28 | """Ensure we can create an instance of Modules.""" 29 | mixer.blend(Module) 30 | assert Module.objects.count() == 1 31 | 32 | def test_query(self): 33 | """Ensure we can query for instances.""" 34 | mixer.blend(Module, name="eog") 35 | r = Module.objects.get(name__exact="eog") 36 | assert r.name == "eog" 37 | 38 | def test_dist_git_url(self): 39 | """ Ensure the dist_git_url field is properly computed """ 40 | mixer.blend(Module, name="eog") 41 | r = Module.objects.get(name__exact="eog") 42 | assert r.dist_git_url == "https://src.fedoraproject.org/modules/eog" 43 | 44 | 45 | class ContainerTest(TestCase): 46 | def test_create(self): 47 | """Ensure we can create an instance of Modules.""" 48 | mixer.blend(Container) 49 | assert Container.objects.count() == 1 50 | 51 | def test_query(self): 52 | """Ensure we can query for instances.""" 53 | mixer.blend(Container, name="origin") 54 | r = Container.objects.get(name__exact="origin") 55 | assert r.name == "origin" 56 | 57 | def test_dist_git_url(self): 58 | """ Ensure the dist_git_url field is properly computed """ 59 | mixer.blend(Container, name="origin") 60 | r = Container.objects.get(name__exact="origin") 61 | assert r.dist_git_url == "https://src.fedoraproject.org/container/origin" 62 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Welcome! Thank you for taking the time to contribute. This project relies on an active and involved community, and we really appreciate your support. 4 | 5 | ## Quickstart 6 | 7 | 1. Look for an [existing issue](https://github.com/fedora-infra/fpdc/issues) 8 | about the bug or feature you're interested in. If you can't find an existing issue, 9 | create a [new one](https://github.com/fedora-infra/fpdc/issues/new). 10 | 11 | 2. Fork the [repository on GitHub](https://github.com/fedora-infra/fpdc). 12 | 13 | 3. Fix the bug or add the feature, and then write one or more tests which show 14 | the bug is fixed or the feature works. 15 | 16 | 4. Submit a pull request and wait for a maintainer to review it. 17 | 18 | More detailed guidelines to help ensure your submission goes smoothly are 19 | below. 20 | 21 | ## Guidelines 22 | 23 | ### Python Support 24 | 25 | fpdc supports Python 3.6 version. This is automatically enforced by the continuous integration (CI) suite. 26 | 27 | ### Code Style 28 | 29 | We follow the [PEP8](https://www.python.org/dev/peps/pep-0008/) style guide 30 | for Python. This is automatically enforced by the CI suite. 31 | 32 | We are using [Black](https://github.com/ambv/black) to automatically format 33 | the source code. It is also checked in CI. The Black webpage contains 34 | instructions to configure your editor to run it on the files you edit. 35 | 36 | Note : The max line length is configured to be 100. 37 | 38 | ### Code Complexity 39 | 40 | We use [radon](https://radon.readthedocs.io/en/latest/index.html) to check the code complexy of the application. 41 | We aim for fpdc to stay withing the A-C [rank of complexity](https://radon.readthedocs.io/en/latest/commandline.html#the-cc-command) and this is 42 | enforced by the CI pipeline. 43 | 44 | When making a change to the code base you can run radon manually: 45 | 46 | ``` 47 | (.venv) pip install radon 48 | (.venv) radon cc fpdc/ -e *.sqlite3,*.pyc 49 | ``` 50 | 51 | ### Tests 52 | 53 | The test suites can be run using [tox](http://tox.readthedocs.io/) by simply 54 | running ``tox`` from the repository root. We aim for all code to have test coverage or 55 | be explicitly marked as not covered using the ``# no-qa`` comment. We encourage the [Test 56 | Driven Development Practice](http://www.extremeprogramming.org/rules/testfirst.html) 57 | 58 | Your pull request should contain tests for your new feature or bug fix. If 59 | you're not certain how to write tests, we will be happy to help you. 60 | -------------------------------------------------------------------------------- /DEVELOPING.md: -------------------------------------------------------------------------------- 1 | # Setup the Local Development 2 | 3 | fpdc requires Python 3.6.0+ to run. You can setup a local development environment using Python virtual environments. 4 | 5 | Create a virtual environment 6 | 7 | ``` 8 | $ python3.6 -m venv .venv 9 | ``` 10 | 11 | Activate the virtual environment 12 | 13 | ``` 14 | $ source .venv/bin/activate 15 | ``` 16 | 17 | First upgrade pip and then install the dependencies 18 | 19 | ``` 20 | (.venv) $ pip install -U pip 21 | (.venv) $ pip install -r requirements-dev.txt 22 | ``` 23 | 24 | Get a client ID and secret, if you don't already have one. 25 | 26 | ``` 27 | (.venv) $ oidc-register https://iddev.fedorainfracloud.org/openidc/ http://localhost:12345/ http://localhost:23456/ http://localhost:8000/oidc/callback/ 28 | ``` 29 | 30 | You can also use curl if you do not wish to use `oidc-register` 31 | 32 | ``` 33 | (.venv) $ curl --request POST --header "Content-Type: application/json" --data '{"redirect_uris": ["http://localhost:1234", "http://localhost:8000/oidc/callback/"], "application_type": "native", "token_endpoint_auth_method": "client_secret_post"}' https://iddev.fedorainfracloud.org/openidc/Registration 34 | ``` 35 | 36 | Extract the client ID and secret received from the provider (inside the client_secrets.json file) above and export them into the virtual 37 | environment: 38 | 39 | ``` 40 | (.venv) $ export OIDC_RP_CLIENT_ID=... 41 | (.venv) $ export OIDC_RP_CLIENT_SECRET=... 42 | ``` 43 | 44 | ### container development environment 45 | 46 | A container based environment is available to give access to a development environment 47 | which is close to the production environment. 48 | 49 | In order to use the client ID and secret generated in the previous step, put the ID 50 | and secret into a `.env` file in the project root. 51 | 52 | ``` 53 | $ cat > .env < OIDC_RP_CLIENT_ID=... 55 | > OIDC_RP_CLIENT_SECRET=... 56 | > EOF 57 | $ 58 | ``` 59 | 60 | To start with this environment first make sure you have podman installed and running on your system. 61 | 62 | ``` 63 | $ sudo dnf install podman 64 | ``` 65 | 66 | Note: The following requires at least podman version 1.0.0 67 | 68 | If you are not running fedora you can check how to install podman on your system [here](https://github.com/containers/libpod/blob/master/install.md) 69 | 70 | You also need to have GNU make installed 71 | 72 | ``` 73 | $ sudo dnf install make 74 | ``` 75 | 76 | Once the installation is complete you can build the fpdc-web container 77 | 78 | ``` 79 | $ make build 80 | ``` 81 | 82 | After the container finished building, you can start a pod. This will start 2 containers inside the pod, a container running the django application `fpdc-web` and a container runnning a postgresql database `database` 83 | 84 | ``` 85 | $ make up 86 | ``` 87 | 88 | Then to access the logs of the container use: 89 | 90 | ``` 91 | $ make logs-web 92 | $ make logs-db 93 | 94 | ``` 95 | 96 | Finally you can stop the pod: 97 | 98 | ``` 99 | $ make stop 100 | ``` 101 | 102 | Start the pod: 103 | 104 | ``` 105 | $ make start 106 | ``` 107 | 108 | Check which containers are running in the pod: 109 | 110 | ``` 111 | $ make ps 112 | ``` 113 | 114 | To brind down the pod: 115 | 116 | ``` 117 | $ make down 118 | ``` 119 | 120 | Clean the database volume: 121 | 122 | ``` 123 | $ make prune 124 | ``` 125 | 126 | You can also get a shell access to the fpdc-web container 127 | 128 | ``` 129 | $ make shell 130 | ``` 131 | 132 | ### Running the tests 133 | 134 | You can run the tests with the following command. 135 | 136 | ``` 137 | $ py.test 138 | ``` 139 | 140 | You can also run all the checks (linting, format and licenses) that are validated by the CI pipeline using the tox command. 141 | 142 | ``` 143 | $ tox 144 | ``` 145 | 146 | # Client examples 147 | 148 | ### Create a new release 149 | 150 | An example of scripts that creates a new release using the OIDC authentication is available under `examples`. 151 | 152 | ``` 153 | $ docker-compose up -d 154 | $ python examples/create_release.py 155 | ``` 156 | 157 | This script will open the browser and ask you to login using you FAS credentials. 158 | -------------------------------------------------------------------------------- /fpdc/settings/base.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for fpdc project. 3 | 4 | Generated by 'django-admin startproject' using Django 1.11. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.11/topics/settings/ 8 | 9 | For the full list of settings and their values, see 10 | https://docs.djangoproject.com/en/1.11/ref/settings/ 11 | """ 12 | 13 | import os 14 | 15 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 16 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 17 | 18 | 19 | # Quick-start development settings - unsuitable for production 20 | # See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ 21 | 22 | # SECURITY WARNING: keep the secret key used in production secret! 23 | SECRET_KEY = "change-this-in-production" 24 | 25 | # SECURITY WARNING: don't run with debug turned on in production! 26 | DEBUG = True 27 | 28 | ALLOWED_HOSTS = [] 29 | 30 | 31 | # Application definition 32 | 33 | INSTALLED_APPS = [ 34 | "django.contrib.auth", 35 | "django.contrib.contenttypes", 36 | "django.contrib.sessions", 37 | "django.contrib.messages", 38 | "django.contrib.staticfiles", 39 | "rest_framework", 40 | "computed_property", 41 | "mozilla_django_oidc", 42 | # fpdc apps 43 | "fpdc.releases", 44 | "fpdc.components", 45 | "fpdc.common", 46 | ] 47 | 48 | MIDDLEWARE = [ 49 | "django.middleware.security.SecurityMiddleware", 50 | # Use whitenoise to manage static pages. Middleware order matters 51 | # http://whitenoise.evans.io/en/stable/#quickstart-for-django-apps 52 | "whitenoise.middleware.WhiteNoiseMiddleware", 53 | "django.contrib.sessions.middleware.SessionMiddleware", 54 | "django.middleware.common.CommonMiddleware", 55 | "django.middleware.csrf.CsrfViewMiddleware", 56 | "django.contrib.auth.middleware.AuthenticationMiddleware", 57 | "django.contrib.messages.middleware.MessageMiddleware", 58 | "django.middleware.clickjacking.XFrameOptionsMiddleware", 59 | ] 60 | 61 | ROOT_URLCONF = "fpdc.urls" 62 | 63 | TEMPLATES = [ 64 | { 65 | "BACKEND": "django.template.backends.django.DjangoTemplates", 66 | "DIRS": [BASE_DIR, os.path.join(BASE_DIR, "templates")], 67 | "APP_DIRS": True, 68 | "OPTIONS": { 69 | "context_processors": [ 70 | "django.template.context_processors.debug", 71 | "django.template.context_processors.request", 72 | "django.contrib.auth.context_processors.auth", 73 | "django.contrib.messages.context_processors.messages", 74 | ] 75 | }, 76 | } 77 | ] 78 | 79 | WSGI_APPLICATION = "fpdc.wsgi.application" 80 | 81 | # Rest Framework 82 | REST_FRAMEWORK = { 83 | "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination", 84 | "PAGE_SIZE": 10, 85 | "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.NamespaceVersioning", 86 | "DEFAULT_PERMISSION_CLASSES": ( 87 | "rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly", 88 | ), 89 | "DEFAULT_AUTHENTICATION_CLASSES": ["mozilla_django_oidc.contrib.drf.OIDCAuthentication"], 90 | } 91 | 92 | 93 | # Database 94 | # https://docs.djangoproject.com/en/1.11/ref/settings/#databases 95 | 96 | DATABASES = { 97 | "default": { 98 | "ENGINE": "django.db.backends.postgresql", 99 | "NAME": "postgres", 100 | "USER": "postgres", 101 | "HOST": "127.0.0.1", 102 | "PORT": 5432, 103 | } 104 | } 105 | 106 | 107 | # Password validation 108 | # https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators 109 | 110 | AUTH_PASSWORD_VALIDATORS = [ 111 | {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"}, 112 | {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"}, 113 | {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"}, 114 | {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"}, 115 | ] 116 | 117 | # Authentication backends 118 | # https://docs.djangoproject.com/en/1.11/ref/settings/#authentication-backends 119 | 120 | AUTHENTICATION_BACKENDS = ["django.contrib.auth.backends.ModelBackend"] 121 | 122 | # OIDC Settings 123 | OIDC_RP_SIGN_ALGO = "RS256" 124 | OIDC_OP_JWKS_ENDPOINT = "https://iddev.fedorainfracloud.org/openidc/Jwks" 125 | OIDC_RP_CLIENT_ID = os.getenv("OIDC_RP_CLIENT_ID") 126 | OIDC_RP_CLIENT_SECRET = os.getenv("OIDC_RP_CLIENT_SECRET") 127 | OIDC_OP_AUTHORIZATION_ENDPOINT = "https://iddev.fedorainfracloud.org/openidc/Authorization" 128 | OIDC_OP_TOKEN_ENDPOINT = "https://iddev.fedorainfracloud.org/openidc/Token" 129 | OIDC_OP_USER_ENDPOINT = "https://iddev.fedorainfracloud.org/openidc/UserInfo" 130 | LOGIN_REDIRECT_URL = "/" 131 | LOGOUT_REDIRECT_URL = "/" 132 | LOGIN_REDIRECT_URL_FAILURE = "/error" 133 | OIDC_RP_SCOPES = "openid profile email" 134 | OIDC_DRF_AUTH_BACKEND = "fpdc.oidc_backend.FpdcOIDCAuthenticationBackend" 135 | 136 | 137 | # Internationalization 138 | # https://docs.djangoproject.com/en/1.11/topics/i18n/ 139 | 140 | LANGUAGE_CODE = "en-us" 141 | 142 | TIME_ZONE = "UTC" 143 | 144 | USE_I18N = True 145 | 146 | USE_L10N = True 147 | 148 | USE_TZ = True 149 | 150 | 151 | # Static files (CSS, JavaScript, Images) 152 | # https://docs.djangoproject.com/en/1.11/howto/static-files/ 153 | 154 | STATIC_URL = "/static/" 155 | STATIC_ROOT = "/opt/app-root/static/" 156 | 157 | # Logging settings 158 | LOGGING = { 159 | "version": 1, 160 | "disable_existing_loggers": False, 161 | "handlers": {"console": {"class": "logging.StreamHandler"}}, 162 | "loggers": { 163 | "django": {"handlers": ["console"], "level": os.getenv("DJANGO_LOG_LEVEL", "DEBUG")} 164 | }, 165 | } 166 | 167 | # FPDC Settings 168 | 169 | # FAS group that give permission to create add and delete resources 170 | FAS_GROUP = "releng-team" 171 | 172 | # Overriden in production and staging to use https://fpdc.{stg.}fedoraproject.org 173 | COREAPI_URL = "http://localhost:8000/" 174 | 175 | # Dist Git URL 176 | DIST_GIT_URL = "https://src.fedoraproject.org/{namespace}/{name}" 177 | -------------------------------------------------------------------------------- /fpdc/releases/tests/test_views.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | from django.contrib.auth.models import User, Group, ContentType 3 | 4 | from mixer.backend.django import mixer 5 | from rest_framework import status 6 | from rest_framework.reverse import reverse 7 | from rest_framework.test import APITestCase 8 | 9 | from fpdc.releases.models import Release 10 | 11 | DATA = { 12 | "release_id": "fedora-27", 13 | "short": "fedora", 14 | "name": "Fedora", 15 | "version": 27, 16 | "release_date": "2017-11-14", 17 | "eol_date": "2018-11-30", 18 | "sigkey": "0xdeadbeef", 19 | } 20 | 21 | 22 | class ReleaseViewTests(APITestCase): 23 | @classmethod 24 | def setUpTestData(cls): 25 | cls.user = mixer.blend(User) 26 | releases = ContentType.objects.get(app_label="releases") 27 | releases_permissions = list(releases.permission_set.all()) 28 | group = Group.objects.create(name="releng-team") 29 | group.permissions.set(releases_permissions) 30 | group.user_set.add(cls.user) 31 | 32 | def test_create_release(self): 33 | url = reverse("v1:release-list") 34 | self.client.force_authenticate(self.__class__.user) 35 | response = self.client.post(url, DATA, format="json") 36 | assert response.status_code == status.HTTP_201_CREATED 37 | assert Release.objects.count() == 1 38 | assert Release.objects.get().release_id == "fedora-27" 39 | 40 | def test_update_release(self): 41 | release = mixer.blend(Release) 42 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 43 | self.client.force_authenticate(self.__class__.user) 44 | response = self.client.put(url, DATA, format="json") 45 | assert response.status_code == status.HTTP_200_OK 46 | assert Release.objects.count() == 1 47 | assert Release.objects.get().release_id == "fedora-27" 48 | 49 | def test_partial_update_release(self): 50 | release = mixer.blend(Release) 51 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 52 | data = {"release_id": "fedora-28"} 53 | self.client.force_authenticate(self.__class__.user) 54 | response = self.client.patch(url, data, format="json") 55 | assert response.status_code == status.HTTP_200_OK 56 | assert Release.objects.count() == 1 57 | assert Release.objects.get().release_id == "fedora-28" 58 | 59 | def test_delete_release(self): 60 | release = mixer.blend(Release) 61 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 62 | assert Release.objects.count() == 1 63 | self.client.force_authenticate(self.__class__.user) 64 | response = self.client.delete(url, format="json") 65 | assert response.status_code == status.HTTP_204_NO_CONTENT 66 | assert Release.objects.count() == 0 67 | 68 | def test_get_release(self): 69 | release = mixer.blend(Release) 70 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 71 | response = self.client.get(url, format="json") 72 | assert response.status_code == status.HTTP_200_OK 73 | assert response.data["release_id"] == release.release_id 74 | 75 | def test_get_release_list(self): 76 | mixer.cycle(5).blend(Release) 77 | url = reverse("v1:release-list") 78 | response = self.client.get(url, format="json") 79 | assert response.status_code == status.HTTP_200_OK 80 | assert Release.objects.count() == 5 81 | 82 | def test_create_release_unauthenticated(self): 83 | url = reverse("v1:release-list") 84 | response = self.client.post(url, DATA, format="json") 85 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 86 | 87 | def test_update_release_unauthenticated(self): 88 | release = mixer.blend(Release) 89 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 90 | response = self.client.put(url, DATA, format="json") 91 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 92 | 93 | def test_partial_update_release_unauthenticated(self): 94 | release = mixer.blend(Release) 95 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 96 | data = {"release_id": "fedora-28"} 97 | response = self.client.patch(url, data, format="json") 98 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 99 | 100 | def test_delete_release_unauthenticated(self): 101 | release = mixer.blend(Release) 102 | url = reverse("v1:release-detail", kwargs={"pk": release.pk}) 103 | assert Release.objects.count() == 1 104 | response = self.client.delete(url, format="json") 105 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 106 | 107 | def test_get_active_releases(self): 108 | active_release = mixer.blend( 109 | Release, 110 | release_date=datetime.date.today(), 111 | eol_date=datetime.date.today() + datetime.timedelta(days=10), 112 | ) 113 | mixer.blend( 114 | Release, 115 | release_date=datetime.date.today(), 116 | eol_date=datetime.date.today() - datetime.timedelta(days=10), 117 | ) 118 | url = reverse("v1:release-list") 119 | response = self.client.get(url, {"active": "true"}) 120 | assert response.status_code == status.HTTP_200_OK 121 | assert response.json().get("count") == 1 122 | assert response.json().get("results")[0]["name"] == active_release.name 123 | 124 | def test_get_inactive_releases(self): 125 | mixer.blend( 126 | Release, 127 | release_date=datetime.date.today(), 128 | eol_date=datetime.date.today() + datetime.timedelta(days=10), 129 | ) 130 | eol_release = mixer.blend( 131 | Release, 132 | release_date=datetime.date.today(), 133 | eol_date=datetime.date.today() - datetime.timedelta(days=10), 134 | ) 135 | url = reverse("v1:release-list") 136 | response = self.client.get(url, {"active": "false"}) 137 | assert response.status_code == status.HTTP_200_OK 138 | assert response.json().get("count") == 1 139 | assert response.json().get("results")[0]["name"] == eol_release.name 140 | -------------------------------------------------------------------------------- /fpdc/components/tests/test_views.py: -------------------------------------------------------------------------------- 1 | from django.contrib.auth.models import User, Group, ContentType 2 | 3 | from mixer.backend.django import mixer 4 | from rest_framework import status 5 | from rest_framework.reverse import reverse 6 | from rest_framework.test import APITestCase 7 | 8 | from fpdc.components.models import RPMPackage, Module, Container 9 | 10 | DATA = {"name": "firefox", "point_of_contact": "gecko-maint"} 11 | 12 | 13 | def add_permissions(user): 14 | components = ContentType.objects.filter(app_label="components") 15 | components_permissions = [] 16 | for component in components: 17 | for permission in list(component.permission_set.all()): 18 | components_permissions.append(permission) 19 | 20 | group = Group.objects.create(name="releng-team") 21 | group.permissions.set(components_permissions) 22 | group.user_set.add(user) 23 | 24 | 25 | class RPMPackageViewTests(APITestCase): 26 | @classmethod 27 | def setUpTestData(cls): 28 | cls.user = mixer.blend(User) 29 | add_permissions(cls.user) 30 | 31 | def test_create_rpm(self): 32 | url = reverse("v1:rpmpackage-list") 33 | self.client.force_authenticate(self.__class__.user) 34 | response = self.client.post(url, DATA, format="json") 35 | assert response.status_code == status.HTTP_201_CREATED 36 | assert RPMPackage.objects.count() == 1 37 | assert RPMPackage.objects.get().name == "firefox" 38 | 39 | def test_update_rpm(self): 40 | rpm = mixer.blend(RPMPackage) 41 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 42 | self.client.force_authenticate(self.__class__.user) 43 | response = self.client.put(url, DATA, format="json") 44 | assert response.status_code == status.HTTP_200_OK 45 | assert RPMPackage.objects.count() == 1 46 | assert RPMPackage.objects.get().name == "firefox" 47 | 48 | def test_partial_update_rpm(self): 49 | rpm = mixer.blend(RPMPackage) 50 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 51 | data = {"name": "guake"} 52 | self.client.force_authenticate(self.__class__.user) 53 | response = self.client.patch(url, data, format="json") 54 | assert response.status_code == status.HTTP_200_OK 55 | assert RPMPackage.objects.count() == 1 56 | assert RPMPackage.objects.get().name == "guake" 57 | 58 | def test_delete_rpm(self): 59 | rpm = mixer.blend(RPMPackage) 60 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 61 | assert RPMPackage.objects.count() == 1 62 | self.client.force_authenticate(self.__class__.user) 63 | response = self.client.delete(url, format="json") 64 | assert response.status_code == status.HTTP_204_NO_CONTENT 65 | assert RPMPackage.objects.count() == 0 66 | 67 | def test_get_rpm(self): 68 | rpm = mixer.blend(RPMPackage) 69 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 70 | response = self.client.get(url, format="json") 71 | assert response.status_code == status.HTTP_200_OK 72 | assert response.data["name"] == rpm.name 73 | 74 | def test_get_rpm_list(self): 75 | mixer.cycle(5).blend(RPMPackage) 76 | url = reverse("v1:rpmpackage-list") 77 | response = self.client.get(url, format="json") 78 | assert response.status_code == status.HTTP_200_OK 79 | assert RPMPackage.objects.count() == 5 80 | 81 | def test_create_rpm_unauthenticated(self): 82 | url = reverse("v1:rpmpackage-list") 83 | response = self.client.post(url, DATA, format="json") 84 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 85 | 86 | def test_update_rpm_unauthenticated(self): 87 | rpm = mixer.blend(RPMPackage) 88 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 89 | response = self.client.put(url, DATA, format="json") 90 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 91 | 92 | def test_partial_update_rpm_unauthenticated(self): 93 | rpm = mixer.blend(RPMPackage) 94 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 95 | data = {"name": "guake"} 96 | response = self.client.patch(url, data, format="json") 97 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 98 | 99 | def test_delete_rpm_unauthenticated(self): 100 | rpm = mixer.blend(RPMPackage) 101 | url = reverse("v1:rpmpackage-detail", kwargs={"pk": rpm.pk}) 102 | assert RPMPackage.objects.count() == 1 103 | response = self.client.delete(url, format="json") 104 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 105 | 106 | 107 | class ModuleViewTests(APITestCase): 108 | @classmethod 109 | def setUpTestData(cls): 110 | cls.user = mixer.blend(User) 111 | add_permissions(cls.user) 112 | 113 | def test_create_module(self): 114 | url = reverse("v1:module-list") 115 | self.client.force_authenticate(self.__class__.user) 116 | response = self.client.post(url, DATA, format="json") 117 | assert response.status_code == status.HTTP_201_CREATED 118 | assert Module.objects.count() == 1 119 | assert Module.objects.get().name == "firefox" 120 | 121 | def test_update_module(self): 122 | module = mixer.blend(Module) 123 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 124 | self.client.force_authenticate(self.__class__.user) 125 | response = self.client.put(url, DATA, format="json") 126 | assert response.status_code == status.HTTP_200_OK 127 | assert Module.objects.count() == 1 128 | assert Module.objects.get().name == "firefox" 129 | 130 | def test_partial_update_module(self): 131 | module = mixer.blend(Module) 132 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 133 | data = {"name": "guake"} 134 | self.client.force_authenticate(self.__class__.user) 135 | response = self.client.patch(url, data, format="json") 136 | assert response.status_code == status.HTTP_200_OK 137 | assert Module.objects.count() == 1 138 | assert Module.objects.get().name == "guake" 139 | 140 | def test_delete_module(self): 141 | module = mixer.blend(Module) 142 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 143 | assert Module.objects.count() == 1 144 | self.client.force_authenticate(self.__class__.user) 145 | response = self.client.delete(url, format="json") 146 | assert response.status_code == status.HTTP_204_NO_CONTENT 147 | assert Module.objects.count() == 0 148 | 149 | def test_get_module(self): 150 | module = mixer.blend(Module) 151 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 152 | response = self.client.get(url, format="json") 153 | assert response.status_code == status.HTTP_200_OK 154 | assert response.data["name"] == module.name 155 | 156 | def test_get_module_list(self): 157 | mixer.cycle(5).blend(Module) 158 | url = reverse("v1:module-list") 159 | response = self.client.get(url, format="json") 160 | assert response.status_code == status.HTTP_200_OK 161 | assert Module.objects.count() == 5 162 | 163 | def test_create_module_unauthenticated(self): 164 | url = reverse("v1:module-list") 165 | response = self.client.post(url, DATA, format="json") 166 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 167 | 168 | def test_update_module_unauthenticated(self): 169 | module = mixer.blend(Module) 170 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 171 | response = self.client.put(url, DATA, format="json") 172 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 173 | 174 | def test_partial_update_module_unauthenticated(self): 175 | module = mixer.blend(Module) 176 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 177 | data = {"name": "guake"} 178 | response = self.client.patch(url, data, format="json") 179 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 180 | 181 | def test_delete_module_unauthenticated(self): 182 | module = mixer.blend(Module) 183 | url = reverse("v1:module-detail", kwargs={"pk": module.pk}) 184 | assert Module.objects.count() == 1 185 | response = self.client.delete(url, format="json") 186 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 187 | 188 | 189 | class ContainerViewTests(APITestCase): 190 | @classmethod 191 | def setUpTestData(cls): 192 | cls.user = mixer.blend(User) 193 | add_permissions(cls.user) 194 | 195 | def test_create_container(self): 196 | url = reverse("v1:container-list") 197 | self.client.force_authenticate(self.__class__.user) 198 | response = self.client.post(url, DATA, format="json") 199 | assert response.status_code == status.HTTP_201_CREATED 200 | assert Container.objects.count() == 1 201 | assert Container.objects.get().name == "firefox" 202 | 203 | def test_update_container(self): 204 | container = mixer.blend(Container) 205 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 206 | self.client.force_authenticate(self.__class__.user) 207 | response = self.client.put(url, DATA, format="json") 208 | assert response.status_code == status.HTTP_200_OK 209 | assert Container.objects.count() == 1 210 | assert Container.objects.get().name == "firefox" 211 | 212 | def test_partial_update_container(self): 213 | container = mixer.blend(Container) 214 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 215 | data = {"name": "guake"} 216 | self.client.force_authenticate(self.__class__.user) 217 | response = self.client.patch(url, data, format="json") 218 | assert response.status_code == status.HTTP_200_OK 219 | assert Container.objects.count() == 1 220 | assert Container.objects.get().name == "guake" 221 | 222 | def test_delete_container(self): 223 | container = mixer.blend(Container) 224 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 225 | assert Container.objects.count() == 1 226 | self.client.force_authenticate(self.__class__.user) 227 | response = self.client.delete(url, format="json") 228 | assert response.status_code == status.HTTP_204_NO_CONTENT 229 | assert Container.objects.count() == 0 230 | 231 | def test_get_container(self): 232 | container = mixer.blend(Container) 233 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 234 | response = self.client.get(url, format="json") 235 | assert response.status_code == status.HTTP_200_OK 236 | assert response.data["name"] == container.name 237 | 238 | def test_get_container_list(self): 239 | mixer.cycle(5).blend(Container) 240 | url = reverse("v1:container-list") 241 | response = self.client.get(url, format="json") 242 | assert response.status_code == status.HTTP_200_OK 243 | assert Container.objects.count() == 5 244 | 245 | def test_create_container_unauthenticated(self): 246 | url = reverse("v1:container-list") 247 | response = self.client.post(url, DATA, format="json") 248 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 249 | 250 | def test_update_container_unauthenticated(self): 251 | container = mixer.blend(Container) 252 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 253 | response = self.client.put(url, DATA, format="json") 254 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 255 | 256 | def test_partial_update_container_unauthenticated(self): 257 | container = mixer.blend(Container) 258 | url = reverse("v1:container-detail", kwargs={"pk": container.pk}) 259 | data = {"name": "guake"} 260 | response = self.client.patch(url, data, format="json") 261 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 262 | 263 | def test_delete_container_unauthenticated(self): 264 | module = mixer.blend(Container) 265 | url = reverse("v1:container-detail", kwargs={"pk": module.pk}) 266 | assert Container.objects.count() == 1 267 | response = self.client.delete(url, format="json") 268 | assert response.status_code == status.HTTP_401_UNAUTHORIZED 269 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------