Release candidate

pipeline/.github/workflows/cloud-51did.yml → .github/workflows/cloud-51did.yml

@@ -1,20 +1,22 @@
 name: Cloud 51Did Tests
 
 # Runs the live cloud 51Did integration test
-# (fiftyone_pipeline_did/tests/test_did_client_live.py) once for every
-# _51DEGREES_RESOURCE_KEY* key passed in below. Each run sets the single
-# _51DEGREES_RESOURCE_KEY the test reads.
+# (pipeline/fiftyone_pipeline_did/tests/test_did_client_live.py) once for
+# every _51DEGREES_RESOURCE_KEY* key passed to its step below. Each run sets
+# the single _51DEGREES_RESOURCE_KEY the test reads first. Those keys carry
+# the FODid product and the CloudV5FODiD product the marketing usages need.
+# The Basic key carries FODid without CloudV5FODiD, so it runs only the
+# tests of what the Basic tier is entitled to (test_did_tier_live.py).
 #
 # The secrets are named one by one rather than passed as toJSON(secrets).
 # GitHub marks a workflow that hands every secret to a step as possibly
 # malicious and holds each run for manual approval, so the nightly never ran.
 # A new resource key therefore needs a line here as well as the organisation
 # secret.
 #
-# The test skips itself when no key is set, so a run with no secrets is green
-# and proves nothing. That is deliberate, because a pull request from a fork
-# has no secrets, and it is the reason the loop below reports which key each
-# run used.
+# A run with no key fails, because a cloud test that passes without calling
+# the cloud has proved nothing. A pull request from a fork gets no secrets,
+# so run this workflow from a branch in this repository.
 
 on:
   workflow_dispatch:
@@ -29,8 +31,8 @@ on:
   pull_request:
     branches: [main]
     paths:
-      - 'fiftyone_pipeline_did/**'
-      - 'owid-python/**'
+      - 'pipeline/fiftyone_pipeline_did/**'
+      - 'pipeline/owid-python/**'
       - '.github/workflows/cloud-51did.yml'
 
 jobs:
@@ -39,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: fiftyone_pipeline_did
+        working-directory: pipeline/fiftyone_pipeline_did
     steps:
       - uses: actions/checkout@v4
         with:
@@ -56,26 +58,27 @@ jobs:
         # runs.
         shell: pwsh
         working-directory: .
-        run: ./ci/copy-owid-source.ps1
+        run: ./pipeline/ci/copy-owid-source.ps1
       - name: Install tox
         run: python -m pip install --upgrade pip tox
       - name: Cloud 51Did test for each resource key secret
         shell: pwsh
         env:
-          _51DEGREES_RESOURCE_KEY_BASIC: ${{ vars._51DEGREES_RESOURCE_KEY_BASIC }}
           _51DEGREES_RESOURCE_KEY_BESPOKE: ${{ secrets._51DEGREES_RESOURCE_KEY_BESPOKE }}
           _51DEGREES_RESOURCE_KEY_51DID: ${{ vars._51DEGREES_RESOURCE_KEY_51DID }}
-          # The redemption tests skip without a license key, and the service
-          # only opens a sealed result for a license key of the account whose
-          # resource key sealed it. So each license key is passed only with
-          # the resource key of the same suffix.
+          # The redemption tests check a sealed result reads back only with a
+          # license key, and the service only opens a sealed result for a
+          # license key of the account whose resource key sealed it. So each
+          # license key is passed only with the resource key of the same
+          # suffix, and a resource key without one checks that the result
+          # redeems as unreadable.
           _51DEGREES_LICENSE_KEY_51DID: ${{ secrets._51DEGREES_LICENSE_KEY_51DID }}
         run: |
           $keys = Get-ChildItem env: |
             Where-Object { $_.Name -like '_51DEGREES_RESOURCE_KEY*' -and $_.Value }
           if (-not $keys) {
-            Write-Host 'No _51DEGREES_RESOURCE_KEY* secrets available; skipping.'
-            exit 0
+            Write-Host '::error::No _51DEGREES_RESOURCE_KEY* secret reached this job. The tests need a key that carries the FODid product, and the CloudV5FODiD product for the marketing usages.'
+            exit 1
           }
           $failed = $false
           foreach ($k in $keys) {
@@ -84,10 +87,14 @@ jobs:
             $licenseName = $k.Name -replace '^_51DEGREES_RESOURCE_KEY', '_51DEGREES_LICENSE_KEY'
             $env:_51DEGREES_LICENSE_KEY = [Environment]::GetEnvironmentVariable($licenseName)
             Write-Host "License key: $(if ($env:_51DEGREES_LICENSE_KEY) { $licenseName } else { 'none' })"
-            # -rs prints why each skipped test skipped, which tells a run that
-            # lacked a key apart from one the service turned away.
+            # -rs lists any test that skipped, and none should.
             tox -- tests/test_did_client_live.py -v -rs
             if ($LASTEXITCODE -ne 0) { $failed = $true }
             Write-Host '::endgroup::'
           }
           if ($failed) { exit 1 }
+      - name: Cloud 51Did tier test with the Basic key
+        if: ${{ !cancelled() }}
+        env:
+          _51DEGREES_RESOURCE_KEY_BASIC: ${{ vars._51DEGREES_RESOURCE_KEY_BASIC }}
+        run: tox -- tests/test_did_tier_live.py -v -rs

.github/workflows/environment-variable-names.yml

@@ -0,0 +1,30 @@
+name: Environment variable names
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - rc
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  environment-variable-names:
+    name: No tracked file names a variable starting with a digit or a fallback name
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Test the check
+        shell: pwsh
+        run: Invoke-Pester -Path ./ci/check-environment-variable-names.Tests.ps1 -CI
+
+      - name: Check the names
+        shell: pwsh
+        run: ./ci/check-environment-variable-names.ps1

AGENTS.md

@@ -207,17 +207,16 @@ which is the configuration the example's own message names, and a key for IP
 Intelligence in the
 [configurator](https://configure.51degrees.com/?utm_source=github&utm_medium=docs&utm_campaign=51degrees-python&utm_content=agents.md&utm_term=cloud-examples).
 
-The Device Detection cloud example takes the key as its first argument, or
-from `_51DEGREES_RESOURCE_KEY`, or from the older name `resource_key`, which
-the Device Detection README uses. The IP Intelligence cloud example takes it
-as its first argument or from `resource_key`.
+The Device Detection and IP Intelligence cloud examples take the key as
+their first argument, or from `_51DEGREES_RESOURCE_KEY`.
 
 ```
-resource_key=<key> python -m fiftyone_devicedetection_examples.cloud.gettingstarted_console
-resource_key=<key> python -m fiftyone_ipintelligence_examples.cloud.gettingstarted_console
+_51DEGREES_RESOURCE_KEY=<key> python -m fiftyone_devicedetection_examples.cloud.gettingstarted_console
+_51DEGREES_RESOURCE_KEY=<key> python -m fiftyone_ipintelligence_examples.cloud.gettingstarted_console
 ```
 
-In PowerShell, set `$env:resource_key = '<key>'` first. Without a key, each
+In PowerShell, set `$env:_51DEGREES_RESOURCE_KEY = '<key>'` first. Without
+a key, each
 example logs an error that names the variable and the configurator.
 
 ### Pitfalls
@@ -301,8 +300,11 @@ The data files come through cxx's own `data` submodule, at
 `cxx/data/device-detection` and `cxx/data/ip-intelligence`, where each free
 file is a `<file>.link` that `cxx/data/get-data-files.ps1` or
 `cxx/data/get-data-files.sh` downloads. Each product's `ci/fetch-assets.ps1`
-gets the files its tests need, and the examples' `example_utils.py` runs the
-script for a file that is missing. The IP Intelligence on-premise package must
+gets the files its tests need from common-ci's assets, which each run caches
+once, so no test job downloads a data file. A file added to the data
+repository needs an entry in common-ci's `steps/fetch-assets.ps1` before CI
+can use it. The examples' `example_utils.py` runs the script for a file
+that is missing. The IP Intelligence on-premise package must
 compile its own copy of the common C library with large data file support;
 the Device Detection one without it.
 

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Contributions are welcome. The [51Degrees contributing guide](https://github.com/51Degrees/.github/blob/main/CONTRIBUTING.md)
+explains where a change goes and how to propose it. It applies to every
+package in this repository.

LICENSE

@@ -1,44 +1,44 @@
 European Union Public Licence
 V. 1.2
 
-EUPL © the European Union 2007, 2016
+EUPL © the European Union 2007, 2016
 
-This European Union Public Licence (the ‘EUPL’) applies to the Work (as
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as
 defined below) which is provided under the terms of this Licence. Any use of
 the Work, other than as authorised under this Licence is prohibited (to the
 extent such use is covered by a right of the copyright holder of the Work).
 
 The Work is provided under the terms of this Licence when the Licensor (as
 defined below) has placed the following notice immediately following the
-copyright notice for the Work: “Licensed under the EUPL”, or has expressed by
+copyright notice for the Work: “Licensed under the EUPL”, or has expressed by
 any other means his willingness to license under the EUPL.
 
 1. Definitions
 
 In this Licence, the following terms have the following meaning:
-— ‘The Licence’: this Licence.
-— ‘The Original Work’: the work or software distributed or communicated by the
-  ‘Licensor under this Licence, available as Source Code and also as
-  ‘Executable Code as the case may be.
-— ‘Derivative Works’: the works or software that could be created by the
-  ‘Licensee, based upon the Original Work or modifications thereof. This
-  ‘Licence does not define the extent of modification or dependence on the
-  ‘Original Work required in order to classify a work as a Derivative Work;
-  ‘this extent is determined by copyright law applicable in the country
-  ‘mentioned in Article 15.
-— ‘The Work’: the Original Work or its Derivative Works.
-— ‘The Source Code’: the human-readable form of the Work which is the most
+— ‘The Licence’: this Licence.
+— ‘The Original Work’: the work or software distributed or communicated by the
+  ‘Licensor under this Licence, available as Source Code and also as
+  ‘Executable Code as the case may be.
+— ‘Derivative Works’: the works or software that could be created by the
+  ‘Licensee, based upon the Original Work or modifications thereof. This
+  ‘Licence does not define the extent of modification or dependence on the
+  ‘Original Work required in order to classify a work as a Derivative Work;
+  ‘this extent is determined by copyright law applicable in the country
+  ‘mentioned in Article 15.
+— ‘The Work’: the Original Work or its Derivative Works.
+— ‘The Source Code’: the human-readable form of the Work which is the most
   convenient for people to study and modify.
 
-— ‘The Executable Code’: any code which has generally been compiled and which
+— ‘The Executable Code’: any code which has generally been compiled and which
   is meant to be interpreted by a computer as a program.
-— ‘The Licensor’: the natural or legal person that distributes or communicates
+— ‘The Licensor’: the natural or legal person that distributes or communicates
   the Work under the Licence.
-— ‘Contributor(s)’: any natural or legal person who modifies the Work under
+— ‘Contributor(s)’: any natural or legal person who modifies the Work under
   the Licence, or otherwise contributes to the creation of a Derivative Work.
-— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
   the Work under the terms of the Licence.
-— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
   renting, distributing, communicating, transmitting, or otherwise making
   available, online or offline, copies of the Work or providing access to its
   essential functionalities at the disposal of any other natural or legal
@@ -50,15 +50,15 @@ The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
 sublicensable licence to do the following, for the duration of copyright
 vested in the Original Work:
 
-— use the Work in any circumstance and for all usage,
-— reproduce the Work,
-— modify the Work, and make Derivative Works based upon the Work,
-— communicate to the public, including the right to make available or display
+— use the Work in any circumstance and for all usage,
+— reproduce the Work,
+— modify the Work, and make Derivative Works based upon the Work,
+— communicate to the public, including the right to make available or display
   the Work or copies thereof to the public and perform publicly, as the case
   may be, the Work,
-— distribute the Work or copies thereof,
-— lend and rent the Work or copies thereof,
-— sublicense rights in the Work or copies thereof.
+— distribute the Work or copies thereof,
+— lend and rent the Work or copies thereof,
+— sublicense rights in the Work or copies thereof.
 
 Those rights can be exercised on any media, supports and formats, whether now
 known or later invented, as far as the applicable law permits so.
@@ -104,7 +104,7 @@ Copyleft clause: If the Licensee distributes or communicates copies of the
 Original Works or Derivative Works, this Distribution or Communication will be
 done under the terms of this Licence or of a later version of this Licence
 unless the Original Work is expressly distributed only under this version of
-the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
 (becoming Licensor) cannot offer or impose any additional terms or conditions
 on the Work or Derivative Work that alter or restrict the terms of the
 Licence.
@@ -113,7 +113,7 @@ Compatibility clause: If the Licensee Distributes or Communicates Derivative
 Works or copies thereof based upon both the Work and another work licensed
 under a Compatible Licence, this Distribution or Communication can be done
 under the terms of this Compatible Licence. For the sake of this clause,
-‘Compatible Licence’ refers to the licences listed in the appendix attached to
+‘Compatible Licence’ refers to the licences listed in the appendix attached to
 this Licence. Should the Licensee's obligations under the Compatible Licence
 conflict with his/her obligations under this Licence, the obligations of the
 Compatible Licence shall prevail.
@@ -146,9 +146,9 @@ terms of this Licence.
 
 The Work is a work in progress, which is continuously improved by numerous
 Contributors. It is not a finished work and may therefore contain defects or
-‘bugs’ inherent to this type of development.
+‘bugs’ inherent to this type of development.
 
-For the above reason, the Work is provided under the Licence on an ‘as is’
+For the above reason, the Work is provided under the Licence on an ‘as is’
 basis and without warranties of any kind concerning the Work, including
 without limitation merchantability, fitness for a particular purpose, absence
 of defects or errors, accuracy, non-infringement of intellectual property
@@ -181,8 +181,8 @@ liability.
 
 10. Acceptance of the Licence
 
-The provisions of this Licence can be accepted by clicking on an icon ‘I
-agree’ placed under the bottom of a window displaying the text of this Licence
+The provisions of this Licence can be accepted by clicking on an icon ‘I
+agree’ placed under the bottom of a window displaying the text of this Licence
 or by affirming consent in any other similar way, in accordance with the rules
 of applicable law. Clicking on that icon indicates your clear and irrevocable
 acceptance of this Licence and all of its terms and conditions.
@@ -232,55 +232,43 @@ their choice.
 14. Jurisdiction
 
 Without prejudice to specific agreement between parties,
-— any litigation resulting from the interpretation of this License, arising
+— any litigation resulting from the interpretation of this License, arising
   between the European Union institutions, bodies, offices or agencies, as a
   Licensor, and any Licensee, will be subject to the jurisdiction of the Court
   of Justice of the European Union, as laid down in article 272 of the Treaty
   on the Functioning of the European Union,
-— any litigation arising between other parties and resulting from the
+— any litigation arising between other parties and resulting from the
   interpretation of this License, will be subject to the exclusive
   jurisdiction of the competent court where the Licensor resides or conducts
   its primary business.
 
 15. Applicable Law
 
 Without prejudice to specific agreement between parties,
-— this Licence shall be governed by the law of the European Union Member State
+— this Licence shall be governed by the law of the European Union Member State
   where the Licensor has his seat, resides or has his registered office,
-— this licence shall be governed by Belgian law if the Licensor has no seat,
+— this licence shall be governed by Belgian law if the Licensor has no seat,
   residence or registered office inside a European Union Member State.
 
 Appendix
 
-‘Compatible Licences’ according to Article 5 EUPL are:
-— GNU General Public License (GPL) v. 2, v. 3
-— GNU Affero General Public License (AGPL) v. 3
-— Open Software License (OSL) v. 2.1, v. 3.0
-— Eclipse Public License (EPL) v. 1.0
-— CeCILL v. 2.0, v. 2.1
-— Mozilla Public Licence (MPL) v. 2
-— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
-— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+‘Compatible Licences’ according to Article 5 EUPL are:
+— GNU General Public License (GPL) v. 2, v. 3
+— GNU Affero General Public License (AGPL) v. 3
+— Open Software License (OSL) v. 2.1, v. 3.0
+— Eclipse Public License (EPL) v. 1.0
+— CeCILL v. 2.0, v. 2.1
+— Mozilla Public Licence (MPL) v. 2
+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
   works other than software
-— European Union Public Licence (EUPL) v. 1.1, v. 1.2
-— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or
+— European Union Public Licence (EUPL) v. 1.1, v. 1.2
+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or
   Strong Reciprocity (LiLiQ-R+)
 
-— The European Commission may update this Appendix to later versions of the
+— The European Commission may update this Appendix to later versions of the
   above licences without producing a new version of the EUPL, as long as they
   provide the rights granted in Article 2 of this Licence and protect the
   covered Source Code from exclusive appropriation.
-— All other changes or additions to this Appendix require the production of a
+— All other changes or additions to this Appendix require the production of a
   new EUPL version.
-
-/* *********************************************************************
-* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
-* amended by the European Commission) shall be deemed incompatible for
-* the purposes of the Work and the provisions of the compatibility
-* clause in Article 5 of the EUPL shall not apply.
-* 
-* If using the Work as, or as part of, a network application, by 
-* including the attribution notice(s) required under Article 5 of the EUPL
-* in the end user terms of the application under an appropriate heading, 
-* such notice(s) shall fulfil the requirements of that article.
-* ********************************************************************* */