fiftyone.geolocation 4.3.0 → 4.3.5

package/ci/common-ci/cloud-release-config.json

@@ -0,0 +1,51 @@
+{
+	"repositories": {
+		"common-ci": {
+			"version": "4.3.16",
+			"isLeaf": true
+		},
+		"pipeline-dotnet": {
+			"version": "4.3.7",
+			"packageName": "FiftyOne.Pipeline",
+			"isLeaf": true
+		},
+		"entitlement-dotnet": {
+			"version": "4.1.12",
+			"isLeaf": true
+		},
+		"location-dotnet": {
+		    "version": "4.3.6",
+			"packageName": "FiftyOne.Geolocation",
+			"isLeaf": true
+		},
+		"device-detection-dotnet": {
+			"version": "4.3.7",
+			"packageName": "FiftyOne.DeviceDetection",
+			"isLeaf": true
+		},
+		"internal-engines-dotnet": {
+			"version": "4.3.3",
+			"packageName": "FiftyOne.GeoLocation.OnPremise",
+			"isLeaf": true
+		},
+		"cloud-config": {
+			"version": "4.3.0",
+			"isLeaf": true
+		},
+		"cloud-dotnet": {
+			"version":"4.3.2",
+			"packageName": "FiftyOne.Pipeline.CloudService",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-dotnet",
+				"entitlement-dotnet",
+				"internal-engines-dotnet",
+				"device-detection-dotnet",
+				"location-dotnet",
+				"cloud-config"
+			]
+		}
+	},
+	"approvalRequired": false
+}

package/ci/common-ci/create-tag.yml

@@ -0,0 +1,41 @@
+trigger: 
+  - main
+  - develop
+  - release/*
+
+# Don't trigger for a pull request
+pr: none
+
+# Include shared variables
+variables:
+- template: shared-variables.yml
+
+stages:
+
+- stage: Tagging
+
+  jobs:
+  - job: Tagging
+  
+    pool:
+      vmImage: $(linuxImage)
+     
+    steps:
+    - checkout: self
+      submodules: recursive
+      persistCredentials: true
+    
+    - task: gittools.gitversion.gitversion-task.GitVersion@5
+      displayName: 'Determine Version Number'
+      # Give this task a name so we can use the variables it sets later.
+      name: GitVersion
+      inputs:
+        preferBundledVersion: false
+        configFilePath: '$(Build.SourcesDirectory)/GitVersion.yml'
+    
+    # Add a tag to the git repository with the version number.
+    - task: ATP.ATP-GitTag.GitTag.GitTag@5
+      displayName: 'Tag Repo With Version Number'
+      inputs:
+        tagUser: 'Azure DevOps'
+        tagEmail: 'CIUser@51Degrees.com'

package/ci/common-ci/deploy.yml

@@ -4,8 +4,22 @@ trigger: none
 # Disable automatic runs of this pipeline when a PR is create.
 pr: none
 
+# Include shared variables
+variables:
+- template: shared-variables.yml
+
+# Add the pipeline that builds the packages as a resource.
+# This allows the deployment pipeline to be triggered whenever
+# the build pipeline completes.
+resources:
+  pipelines:
+  - pipeline: build-pipeline   # The name for the triggering build pipeline within this script
+    source: common-ci-tag-repository # Name of the pipeline from here: https://51degrees.visualstudio.com/Pipeline/_build
+    trigger: true
+
 stages:
 - template: shared-publish-github-stage.yml
   parameters:
-    imageName: 'ubuntu-18.04'
-    branchName: 'refs/heads/main'
+    imageName: $(linuxImage)
+    branchName: 'refs/heads/main'
+    skipTagging: false

package/ci/common-ci/dotnet/shared-code-signing-steps.yml

@@ -0,0 +1,20 @@
+parameters:
+- name: codeSigningPassword
+
+steps:
+# The secure file to download will be stored in the 
+# Pipelines/Library/SecureFiles section in Azure DevOps.
+- task: DownloadSecureFile@1
+  displayName: 'Download Code Signing Certificate'
+  name: CodeSigningCert
+  inputs:
+    secureFile: '51Degrees Private Code Signing Certificate.pfx'
+    
+# Sign the Nuget package with the file downloaded previously.
+# The password is stored in the Pipelines/Library/VariableGroups
+# section in Azure DevOps.
+- task: NuGetCommand@2
+  displayName: 'Sign NuGet Package'
+  inputs:
+    command: custom
+    arguments: 'sign $(System.ArtifactsDirectory)\*.nupkg -CertificatePath "$(CodeSigningCert.secureFilePath)" -CertificatePassword ${{ parameters.codeSigningPassword }} -Timestamper http://timestamp.digicert.com'

package/ci/common-ci/dotnet/shared-extract-and-publish-packages.yml

@@ -0,0 +1,29 @@
+parameters:
+- name: nugetVersion
+- name: nugetFeedType
+- name: feed
+
+steps:
+
+# Install NuGet and restore packages
+- task: NuGetToolInstaller@1
+  displayName: 'Use NuGet ${{ parameters.nugetVersion }}'
+  inputs:
+    versionSpec: ${{ parameters.nugetVersion }}
+
+- task: NuGetCommand@2
+  displayName: 'NuGet publish internal'
+  inputs:
+    command: push
+    packagesToPush: '$(PIPELINE.WORKSPACE)/build-pipeline/drop/**/*.nupkg;!$(PIPELINE.WORKSPACE)/build-pipeline/drop/**/*.symbols.nupkg'
+    publishVstsFeed: '${{ parameters.feed }}'
+  condition: and(succeeded(), eq('${{ parameters.nugetFeedType }}', 'internal'))
+  
+- task: NuGetCommand@2
+  displayName: 'NuGet publish external'
+  inputs:
+    command: push
+    packagesToPush: '$(PIPELINE.WORKSPACE)/build-pipeline/drop/**/*.nupkg;!$(PIPELINE.WORKSPACE)/build-pipeline/drop/**/*.symbols.nupkg'
+    nuGetFeedType: external
+    publishFeedCredentials: 'NuGet.org - Release'
+  condition: and(succeeded(), eq('${{ parameters.nugetFeedType }}', 'external'))

package/ci/common-ci/go/shared-go-list-stage.yml

@@ -0,0 +1,64 @@
+parameters:
+- name: stageDependencies
+  type: object
+  default: []
+- name: goVersion
+  type: string
+  default: '1.17.1'
+
+stages:
+# This stage check if current branch runs on a pull request merge branch,
+# then try to complete the pull request if it is true.
+# WARNINGS: This stage should be run at the end of a pipeline, because upon
+# completing a pull request the pipeline will be canceled and no stage
+# or tasks will be run after this.
+- stage: Go_List
+  displayName: "Make module available"
+  dependsOn: ${{ parameters.stageDependencies }}
+
+  variables:
+  - group: CIAutomation # Required to access CI variables
+
+  pool:
+    vmImage: 'ubuntu-18.04'
+    
+  jobs:
+  - job: Go_List
+    
+    steps:
+    - checkout: self
+      submodules: recursive
+      persistCredentials: true
+
+    # Install go
+    - task: GoTool@0
+      displayName: 'Use go ${{ parameters.goVersion }}'
+      inputs:
+        version: '${{ parameters.goVersion }}'
+
+    # Run go list to make the module available
+    - bash: |
+        # Fetch all tags
+        git fetch --all --tags
+        if [ $? != 0 ]; then
+          echo "Failed to fetch all tags."
+          exit 1
+        fi
+
+        # Check out current branch
+        git checkout $(Build.SourceBranchName)
+        if [ $? != 0 ]; then
+          echo "Failed to checkout branch '$(Build.SourceBranchName)'."
+          exit 1
+        fi
+        
+        # Get tag version
+        export tagName="`git tag --points-at $(Build.SourceBranchName)`"
+        
+        # Get module name
+        export modName=`cat go.mod | awk '/module/{print $2}'`
+        
+        # Complete the corresponding pull request
+        GOPROXY=proxy.golang.org go list -m $modName@v$tagName
+      displayName: 'Make module available'
+      condition: and(succeeded(), eq(variables['AutomatedRelease'], 'On'))

package/ci/common-ci/java/readme.md

@@ -0,0 +1,22 @@
+# Java Specific CI/CD Approach
+This API complies with the `common-ci` approach.
+
+## Code Signing
+We use Maven to package our Java APIs. The process of signing the result packages for Maven is different from Dotnet signing process.
+1. The signing process for Java uses `PGP ASCII Armored File` with file extension `.asc` instead of `.pfx` as in Dotnet.
+2. The process requires the `.asc` file to be imported using `gpg`.
+3. Then the result package will be signed as part of Maven `install` process using `maven-gpg-plugin`.
+
+## Deploy External
+The deployment to external of Java Maven packages must be done in the following order:
+
+1. `pipeline-java`
+2. `device-detection-java`
+3. `location-java`
+
+Steps for each java repo:
+1. Deploy packages to Nexus staging area - automatic.
+2. Deploy from Nexus staging to Maven Central - requires approval.
+3. Deploy to GitHub - requires approval.
+
+All Java APIs share a staging area, so occasionally repositories are left in the staging area as a results of a possible cancellation or an unwanted pipeline termination, etc. This sometimes causes the deployment to staging to fail. In this case, it is the best to login to the Nexus staging area and manually drop all unwanted repositories and rerun the deployment process.

package/ci/common-ci/java/shared-package-signing-steps.yml

@@ -0,0 +1,17 @@
+parameters:
+- name: gpgPassPhrase
+
+steps:
+# Download Java Maven GPG Key from SecureFile Library
+- task: DownloadSecureFile@1
+  name: PackageSigningKey
+  displayName: 'Download Maven GPG Key'
+  inputs:
+    secureFile: 'Java Maven GPG Key Private.pgp'
+    retryCount: 5
+
+- task: Bash@3
+  displayName: 'Import Maven GPG Key'
+  inputs:
+    targetType: 'inline'
+    script: 'echo ${{ parameters.gpgPassPhrase }} | gpg --import --batch --yes --passphrase-fd 0 "$(PackageSigningKey.secureFilePath)"'

package/ci/{shared-extract-and-publish-packages.yml → common-ci/node/shared-extract-and-publish-packages.yml}

@@ -1,6 +1,7 @@
 parameters:
 - name: publishConnection
 - name: packageName
+- name: internalFeedId
 
 steps:
 
@@ -16,5 +17,10 @@ steps:
     command: publish
     workingDir: '$(PIPELINE.WORKSPACE)/build-pipeline/npm/${{ parameters.packageName }}/tmp/package'
     verbose: false
-    publishEndpoint: ${{ parameters.publishConnection }}
+    ${{ if eq(parameters.publishConnection, 'NPM publish connection') }}:
+      publishEndpoint: ${{ parameters.publishConnection }}
+    ${{ if eq(parameters.publishConnection, 'NPM internal') }}:
+      publishRegistry: useFeed
+      publishFeed: '${{ parameters.internalFeedId }}'
+      
     

package/ci/common-ci/php/readme.md

@@ -0,0 +1,15 @@
+# PHP Specific CI/CD Approach
+This API complies with the `common-ci` approach.
+
+## Deploy External
+The deployment to external of PHP involves a stage that builds and tests on actual external package. This is not required for internal pipelines such as `build-and-test.yml` as it is acceptable to just use submodule references. However, before deploy to external, the solution is required to work with other external packages. Thus, the deployment to external will fail as some dependencies packages are left waiting for a release engineer to approve. In this case, the failed deployment will need to be rerun after their dependency packages have been deployed to external.
+
+Typically the deploy external pipelines should be completed in the following order:
+
+1. `pipeline-php-core`
+2. `pipeline-php-engines`
+3. `pipeline-php-cloudrequestengine`
+4. `device-detection-php`
+5. `location-php`
+
+`device-detection-onpremise-php` is not deployed as a package to Packagist but should be completed after `device-detection-php`

package/ci/common-ci/release-config-schema.json

@@ -0,0 +1,52 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "title": "Release Config",
+    "description": "Contains the release configuration for 51Degrees DevOps pipelines",
+    "properties": {
+        "repositories": {
+            "type": "object",
+            "patternProperties": {
+                "^[A-Za-z][A-Za-z0-9\\-]*$": {
+                    "type": "object",
+                    "properties": {
+                        "version": {
+                            "type": "string",
+                            "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+                        },
+                        "packageName": {
+                            "type": "string"
+                        },
+                        "versionVariableName": {
+                            "type": "string"
+                        },
+                        "isLeaf": {
+                            "type": "boolean"
+                        },
+                        "dependencies": {
+                            "type": "array",
+                            "items": {
+                                "type": "string",
+                                "pattern": "^[A-Za-z][A-Za-z0-9\\-]*$"
+                            }
+                        }
+                    },
+                    "required": [
+                        "version",
+                        "isLeaf"
+                    ]
+                }
+            },
+            "required": [
+                "common-ci"
+            ]
+        },
+        "approvalRequired": {
+            "type": "boolean"
+        }
+    },
+    "required": [
+        "repositories",
+        "approvalRequired"
+    ]
+}

package/ci/common-ci/release-config-template.json

@@ -0,0 +1,310 @@
+{
+	"repositories": {
+		"common-ci": {
+			"version": "4.3.2",
+			"isLeaf": true
+		},
+		"device-detection-data": {
+			"version": "4.3.1",
+			"isLeaf": false
+		},
+		"common-cxx": {
+			"version": "4.3.1",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"device-detection-cxx": {
+			"version": "4.3.2",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"common-cxx",
+				"device-detection-data"
+			]
+		},
+		"device-detection-varnish": {
+			"version": "4.3.0",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx"
+			]
+		},
+		"device-detection-nginx": {
+			"version": "4.3.1",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx"
+			]
+		},
+		"pipeline-java": {
+			"version": "4.3.0",
+			"packageName": "pipeline",
+			"versionVariableName": "pipeline.version",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"location-java": {
+		    "version": "4.3.0",
+			"packageName": "pipeline.geo-location",
+			"versionVariableName": "geolocation.version",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-java",
+				"device-detection-java"
+			]
+		},
+		"location-onpremise-java": {
+		    "version": "4.3.0",
+			"packageName": "geo-location.digitalelement",
+			"versionVariableName": "geolocation.digitalelement.version",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-java",
+				"location-java"
+			]
+		},
+		"device-detection-java": {
+			"version": "4.3.0",
+			"packageName": "pipeline.device-detection",
+			"versionVariableName": "devicedetection.version",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx",
+				"pipeline-java"
+			]
+		},
+		"common-dotnet": {
+			"version": "4.3.1",
+			"packageName": "FiftyOne.Common",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"caching-dotnet": {
+			"version": "4.3.1",
+			"packageName": "FiftyOne.Caching",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"pipeline-dotnet": {
+			"version": "4.3.1",
+			"packageName": "FiftyOne.Pipeline",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"common-dotnet",
+				"caching-dotnet"
+			]
+		},
+		"location-dotnet": {
+		    "version": "4.3.2",
+			"packageName": "FiftyOne.Geolocation",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"common-dotnet",
+				"pipeline-dotnet",
+				"device-detection-dotnet"
+			]
+		},
+		"device-detection-dotnet": {
+			"version": "4.3.1",
+			"packageName": "FiftyOne.DeviceDetection",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx",
+				"caching-dotnet",
+				"common-dotnet",
+				"pipeline-dotnet"
+			]
+		},
+		"license-dotnet": {
+			"version": "4.3.0",
+			"packageName": "FiftyOne.(License|Resource)",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"entitlement-dotnet": {
+			"version": "4.1.9",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"common-dotnet",
+				"license-dotnet",
+				"pipeline-dotnet"
+			]
+		},
+		"internal-engines-dotnet": {
+			"version": "4.3.0",
+			"packageName": "FiftyOne.GeoLocation.OnPremise",
+			"isLeaf": false,			
+			"dependencies": [
+				"common-ci",
+				"common-dotnet",
+				"pipeline-dotnet",
+				"device-detection-dotnet",
+				"location-dotnet"
+			]
+		},
+		"pipeline-node": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.pipeline",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"location-node": {
+		    "version": "4.3.1",
+			"packageName": "fiftyone.geolocation",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-node",
+				"device-detection-node"
+			]
+		},
+		"device-detection-node": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.devicedetection",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx",
+				"pipeline-node"
+			]
+		},
+		"pipeline-python": {
+			"version": "4.3.1",
+			"packageName": "fiftyone_pipeline",
+			"versionVariableName": "pipelineVersion",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"location-python": {
+		    "version": "4.3.0",
+			"packageName": "fiftyone_location",
+			"versionVariableName": "locationVersion",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-python"
+			]
+		},
+		"device-detection-python": {
+			"version": "4.3.0",
+			"packageName": "fiftyone_devicedetection",
+			"versionVariableName": "deviceDetectionVersion",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx",
+				"pipeline-python"
+			]
+		},
+		"pipeline-php-core": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.pipeline.core",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci"
+			]
+		},
+		"pipeline-php-engines": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.pipeline.engines",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-php-core"
+			]
+		},
+		"pipeline-php-cloudrequestengine": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.pipeline.cloudrequestengine",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-php-core",
+				"pipeline-php-engines"
+			]
+		},
+		"location-php": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.geolocation",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-php-core",
+				"pipeline-php-engines",
+				"pipeline-php-cloudrequestengine",
+				"device-detection-php"
+			]
+		},
+		"device-detection-php-onpremise": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.devicedetection",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx",
+				"pipeline-php-core",
+				"pipeline-php-engines"
+			]
+		},
+		"device-detection-php": {
+			"version": "4.3.1",
+			"packageName": "fiftyone.devicedetection",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-php-core",
+				"pipeline-php-engines",
+				"pipeline-php-cloudrequestengine"
+			]
+		},
+		"pipeline-wordpress": {
+			"version": "0.9.0",
+			"packageName": "fiftyonedegrees.wordpress",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"pipeline-php-cloudrequestengine"
+			]
+		},
+		"device-detection-go": {
+			"version": "4.3.1",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-cxx"
+			]
+		},
+		"device-detection-examples-go": {
+			"version": "4.3.0",
+			"isLeaf": false,
+			"dependencies": [
+				"common-ci",
+				"device-detection-go"
+			]
+		}
+	},
+	"approvalRequired": false
+}