fiftyone.geolocation 4.2.1 → 4.3.3

package/ci/common-ci/shared-auto-complete-pr-stage.yml

@@ -0,0 +1,61 @@
+parameters:
+- name: stageDependencies
+  type: object
+  default: []
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+
+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: Complete_PR
+  displayName: "Check and complete corresponding pull request"
+  dependsOn: ${{ parameters.stageDependencies }}
+
+  variables:
+  - group: CIAutomation # Required to access CI variables
+
+  pool:
+    vmImage: 'windows-2019'
+    
+  jobs:
+  - job: Complete_PR
+    
+    steps:
+    - checkout: self
+      submodules: recursive
+      persistCredentials: true
+
+      # Checkout the common-ci to access the latest release configuration.
+      # Special consideration is given to the cloud project as when executing 
+      # this template the git url would resolve to git://Cloud/common-ci
+      # which is not valid.
+    - ${{ if eq(parameters.project, 'cloud') }}:
+      - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+    - ${{ if ne(parameters.project, 'cloud') }}:
+      - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+      
+    - powershell: |
+        # Install all modules
+        $Env:PSModulePath += ";$($(Get-Location).Path)\common-ci\scripts\modules"
+        Write-Host "Module Path: $($Env:PsModulePath)"
+        
+        # Complete the corresponding pull request
+        cd $Env:BUILD_REPOSITORY_NAME
+        Write-Host "# Try to complete pull request for repository $Env:BUILD_REPOSITORY_NAME."
+        if (!$(Complete-CorrespondingPullRequest -ConfigFile "$($(Get-Location).Path)\..\common-ci\release-config.json")) {
+            Write-Host "# FAILED"
+            exit 1
+        }
+      displayName: 'Complete Pull Request'
+      env:
+        SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+      condition: and(succeeded(), eq(variables['AutomatedRelease'], 'On'))

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

@@ -0,0 +1,23 @@
+parameters:
+- name: imageName # Name of the image to run the job on
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+
+jobs:
+# Determine the version of the current commit.
+- template: shared-git-version-job.yml
+  parameters:
+    imageName: ${{ parameters.imageName }}
+    commonCiRef: ${{ parameters.commonCiRef }}
+    project: ${{ parameters.project }}
+    
+# Tag using the version from the gitversion job
+- template: shared-git-tag-job.yml
+  parameters:
+    imageName: ${{ parameters.imageName }}
+    jobDependencies: [Versioning]

package/ci/common-ci/shared-docker-build-steps.yml

@@ -0,0 +1,34 @@
+# Steps to build a Docker container.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: dockerfilePath # Path to the Dockerfile.
+- name: dockerRegistryServiceConnection # A Docker registry service connection.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+
+steps:
+# Login to the Docker registry
+- task: Docker@2
+  displayName: Docker Login
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'login'
+
+# Build the docker container
+- task: Docker@2
+  displayName: Docker Build
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    repository: '${{ parameters.imageRepository }}'
+    command: 'build'
+    Dockerfile: '${{ parameters.dockerfilePath }}'
+    tags: |
+      ${{ parameters.tag }}
+      latest
+
+# Logout of the Docker registry
+- task: Docker@2
+  displayName: Docker Logout
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'logout'

package/ci/common-ci/shared-docker-push-steps.yml

@@ -0,0 +1,32 @@
+# Steps to push a Docker container to a Docker repository.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: dockerRegistryServiceConnection # A Docker registry service connection.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+
+steps:
+# Login to the Docker registry
+- task: Docker@2
+  displayName: Docker Login
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'login'
+
+# Push the docker container to the registy
+- task: Docker@2
+  displayName: Docker Push
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    repository: '${{ parameters.imageRepository }}'
+    command: 'push'
+    tags: |
+      ${{ parameters.tag }}
+      latest
+      
+# Logout of the Docker registry
+- task: Docker@2
+  displayName: Docker Logout
+  inputs:
+    containerRegistry: '${{ parameters.dockerRegistryServiceConnection }}'
+    command: 'logout'

package/ci/common-ci/shared-docker-test-http-steps.yml

@@ -0,0 +1,69 @@
+# Steps to test a Docker container image which exposes an http interface.
+
+parameters:
+- name: imageRepository # Name of the repository.
+- name: tag # A list of tags in separate lines. e.g. beta1.1, latest
+- name: containerPort # A tcp port for http connections exposed by the container.
+  type: number
+  default: 80
+- name: machinePort # The port to open on the machine.
+  type: number
+  default: 8080
+- name: scheme # The HTTP scheme to use when testing endpoints.
+  type: string
+  default: http
+- name: endpoints # A list of URIs to test against the docker container, these should exclude the base URL, e.g. '/api/info/name'
+  type: object
+  default: []
+- name: additionalDockerArguments # Additional arguments to pass to the docker run command
+  type: string
+  default: '' 
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: 'main'
+- name: instanceName # Name of docker instance to create.
+  type: string
+  default: 'cloudInstance'
+
+steps:
+# Checkout the common-ci repo which contains the checkSlot script.
+# Special consideration is given to the Cloud project as when executing 
+# this template the, git url would resolve to git://Cloud/common-ci
+# which is not valid.
+- ${{ if eq(parameters.project, 'cloud') }}:
+  - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+- ${{ if ne(parameters.project, 'cloud') }}:
+  - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+
+# Run the docker container in detached mode with provided ports and any additional arguments provided in the parameters.
+- task: CmdLine@2
+  inputs:
+    script: 'docker run -d ${{ format(''-p {0}:{1}'', parameters.machinePort, parameters.containerPort) }} ${{ parameters.additionalDockerArguments }} --name ${{ parameters.instanceName }} ${{ parameters.imageRepository }}:${{ parameters.tag }} '
+  displayName: Run docker container
+  
+# List all active docker container instances
+- task: CmdLine@2
+  inputs:
+    script: 'docker ps'
+  displayName: List docker containers
+
+# Check the provided endpoints against the running container.
+- ${{ each endpoint in parameters.endpoints }}:
+  - task: PowerShell@2
+    displayName: 'Test ${{ parameters.scheme }}://localhost:${{ parameters.machinePort }}${{ endpoint }}'
+    inputs:
+      filePath: '$(Build.SourcesDirectory)/common-ci/scripts/azure/checkSlot.ps1'
+      arguments: '-ModulePath $(Build.SourcesDirectory)/common-ci/scripts/modules -Uri ''${{ parameters.scheme }}://localhost:${{ parameters.machinePort }}${{ endpoint }}'''
+      failOnStderr: true
+      
+# Output the logs from container instance.
+- task: CmdLine@2
+  inputs:
+    script: 'docker logs ${{ parameters.instanceName }}'
+  displayName: Output logs
+  # Always run this to make sure logs are available in failure instances.
+  condition: always()

package/ci/common-ci/shared-git-tag-job.yml

@@ -0,0 +1,38 @@
+parameters:
+- name: imageName # Name of the image to run the job on
+- name: jobDependencies
+  type: object
+  default: []
+- name: publishConfig # This indicates where a 'Release' or 'Debug' publish is being used.
+  type: string
+  default: 'Release'
+
+jobs:
+- job: Tagging
+  dependsOn: ${{ parameters.jobDependencies }}
+  condition: and(not(failed()), not(canceled()), eq('${{ parameters.publishConfig }}', 'Release'))
+
+  variables:
+  # Access token for the git repository. Used by the git tag task.
+  - name: SYSTEM_ACCESSTOKEN
+    value: $(System.AccessToken)
+  - name: GitVersionSemVer
+    value: $[ dependencies.Versioning.outputs['SetGitVersionVars.GitVersionSemVer'] ]
+  
+  pool:
+    vmImage: ${{ parameters.imageName }}
+  
+  steps:
+  # The lines below are needed to allow the pipeline access to the
+  # OAuth access token that controls write access to the git repository.
+  # (Required for GitTag task)
+  - checkout: self
+    persistCredentials: true
+  
+  # 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'
+      tag: '$(GitVersionSemVer)'

package/ci/common-ci/shared-git-version-job.yml

@@ -0,0 +1,71 @@
+parameters:
+- name: imageName # Name of the image to run the job on
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+  
+jobs:
+- job: Versioning
+  
+  pool:
+    vmImage: ${{ parameters.imageName }}
+  
+  steps:
+  # The lines below are needed to allow the pipeline access to the
+  # OAuth access token that controls write access to the git repository.
+  # (Required for GitTag task)
+  - checkout: self
+    persistCredentials: true
+  
+  # Checkout the common-ci repo so the GitVersion config file can
+  # be used.
+  # Special consideration is given to the Cloud project as when executing 
+  # this template the, git url would resolve to git://Cloud/common-ci
+  # which is not valid.
+  - ${{ if eq(parameters.project, 'cloud') }}:
+    - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+  - ${{ if ne(parameters.project, 'cloud') }}:
+    - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+
+  # NOTE: This task can be used on both Windows and Linux machine so make sure to use
+  # '\' instead '/', and everything is case sensitive.
+  - powershell: |
+      Write-Host "Check if $($Env:BUILD_REPOSITORY_NAME)/GitVersion.yml exists."
+      if ($(Test-Path $Env:BUILD_REPOSITORY_NAME/GitVersion.yml)) {
+          Write-Host "GitVersion.yml exists in current location."
+          $gitVersionPath = "$($(Get-Location).Path)/$Env:BUILD_REPOSITORY_NAME/GitVersion.yml"
+      } else {
+          Write-Host "Use GitVersion.yml in common-ci."
+          $gitVersionPath = "$($(Get-Location).Path)/common-ci/GitVersion.yml"
+      }
+      Write-Host "# Using GitVersion.yml at $gitVersionPath"
+      Write-Host "##vso[task.setvariable variable=GitVersionPath]$gitVersionPath"
+    name: SetGitVersionPath
+    displayName: 'Determine GitVersion.yml file to use.'
+
+  # GitVersion needs to be 5.6. The standard 5.0 breaks on Ubuntu 20.
+  - task: gitversion/setup@0
+    inputs:
+      versionSpec: '5.6.0'
+
+  - task: gitversion/execute@0
+    inputs:
+      preferBundledVersion: true
+      # As two repos have been checked out, the default path will not
+      # work. So it is specified here.
+      targetPath: '$(Build.Repository.LocalPath)/$(Build.Repository.Name)'
+      useConfigFile: true
+      configFilePath: '$(GitVersionPath)'
+      failOnStderr: true
+
+  - powershell: |
+      Write-Host "##vso[task.setvariable variable=GitVersionSemVer;isOutput=true]$(GitVersion.SemVer)"
+      Write-Host "##vso[task.setvariable variable=GitVersionNuGetVer;isOutput=true]$(GitVersion.NuGetVersion)"
+      Write-Host "##vso[task.setvariable variable=GitVersionAssemblyVer;isOutput=true]$(GitVersion.AssemblySemVer)"
+      Write-Host "##vso[task.setvariable variable=GitVersionAssemblyFileVer;isOutput=true]$(GitVersion.AssemblySemFileVer)"
+    name: SetGitVersionVars
+    displayName: 'Export GitVersion variables'

package/ci/common-ci/shared-publish-github-stage.yml

@@ -0,0 +1,107 @@
+parameters:
+- name: imageName # Name of the platform to run on
+- name: branchName # Name of the branch which is allowed to be published to GitHub
+- name: skipTagging # True if tagging should be skipped for the repository
+  type: boolean
+  default: false
+
+stages:
+- stage: publish_github
+  displayName: Publish to GitHub
+  condition: eq(variables['build.sourceBranch'], '${{ parameters.branchName }}')
+  jobs:
+  - deployment: deploy_github
+    displayName: Deploy to GitHub
+    pool:
+      vmImage: ${{ parameters.imageName }}
+      workspace:
+        clean: all
+    environment: github
+    strategy:
+      runOnce:
+        deploy:
+          steps:
+          
+          - task: DownloadSecureFile@1
+            displayName: 'Download ssh private key'
+            name: githubsshkey
+            inputs:
+              secureFile: 'gihhub-ssh-key'
+              retryCount: 5
+              steps:
+              
+          - task: DownloadSecureFile@1
+            displayName: 'Download ssh public key'
+            name: githubsshkeypublic
+            inputs:
+              secureFile: 'gihhub-ssh-key-public'
+              retryCount: 5
+              
+          - bash: |
+              # Copy ssh keys to expected location
+              mkdir ~/.ssh
+              mv $(githubsshkey.secureFilePath) ~/.ssh/id_rsa
+              mv $(githubsshkeypublic.secureFilePath) ~/.ssh/id_rsa.pub
+              if [ ! -f ~/.ssh/id_rsa ] && [ ! -f ~/.ssh/id_rsa ]; then
+                echo "Failed to obtain ssh keys."
+                exit 1               
+              fi
+              
+              # Have to change permissions on key files in order for SSH to work with them.
+              chmod 600 ~/.ssh/id_rsa
+              chmod 600 ~/.ssh/id_rsa.pub
+              export id_rsa_perm=`stat -c '%a' ~/.ssh/id_rsa`
+              export id_rsa_pub_perm=`stat -c '%a' ~/.ssh/id_rsa.pub`
+              if [ "$id_rsa_perm" != "600" ] && [ "$id_rsa_pub_perm" != "600" ]; then
+                 echo "Failed to change permission on key files."
+                 exit 1
+              fi
+              
+              # Uncomment the line below to debug issues with SSH
+              #ssh -vT git@github.com
+              
+              echo "Cloning git repository"
+              git clone https://a:$(System.AccessToken)@dev.azure.com/51degrees/$(System.TeamProject)/_git/$(Build.Repository.Name) source
+              if [ ! -d source ]; then
+                echo "Failed to checkout repository."
+                exit 1
+              fi
+              
+              cd source
+              
+              echo "Checking out branch '$(Build.SourceBranchName)'"
+              git checkout $(Build.SourceBranchName)
+              if [ $? != 0 ]; then
+                echo "Failed to checkout branch '$(Build.SourceBranchName)'."
+                exit 1
+              fi
+              
+              echo "Adding GitHub remote"
+              git remote add github git@github.com:51Degrees/$(Build.Repository.Name).git
+              if [ $? != 0 ]; then
+                echo "Failed to add GitHub remote."
+                exit 1
+              fi
+              
+              echo "Pushing branch '$(Build.SourceBranchName)' to GitHub"
+              git push github $(Build.SourceBranchName)
+              if [ $? != 0 ]; then
+                echo "Failed to push branch '$(Build.SourceBranchName)' to GitHub."
+                exit 1
+              fi
+            displayName: 'Push branch to Github'
+
+          - ${{ if eq(parameters.skipTagging, false) }}:
+            - bash: |
+                # Move to checkout directory in previous task.
+                cd source
+                
+                export tagName="`git tag --points-at $(Build.SourceBranchName)`"
+                
+                echo "Pushing tag '$tagName' to GitHub"
+                git push github $tagName
+                if [ $? != 0 ]; then
+                  echo "Failed to push tag '$tagName' to GitHub."
+                  exit 1
+                fi
+              displayName: 'Push tags to GitHub'

package/ci/common-ci/shared-submodule-trigger-stage.yml

@@ -0,0 +1,110 @@
+parameters:
+- name: commonCiRef # The common-ci repo reference to checkout.
+  type: string
+  default: main
+- name: releaseConfigFile # The release config file to load.
+  displayName: 'Release Config File'
+  type: string
+  default: release-config.json
+- name: project # The DevOps project executing this template.
+  displayName: 'Calling project is cloud or non-cloud'
+  type: string
+  default: 'non-cloud'
+- name: depTeamProjectName # The DevOps project containing the dependencies.
+  displayName: 'Release Config File'
+  type: string
+  default: ''
+- name: prTeamProjectName # The project containing the repo to update.
+  displayName: 'Release Config File'
+  type: string
+  default: ''
+
+stages:
+- stage: UpdateReference
+  displayName: 'Update Reference'
+  
+  pool:
+    vmImage: windows-2019
+  
+  variables:
+  - group: CIAutomation # Required to access CI variables
+  
+  jobs:
+  - job:
+    
+    steps:
+    - checkout: self
+      submodules: recursive
+      persistCredentials: true
+
+      # Checkout the common-ci to access the latest release configuration.
+      # Special consideration is given to the Cloud project as when executing 
+      # this template the, git url would resolve to git://Cloud/common-ci
+      # which is not valid.
+    - ${{ if eq(parameters.project, 'cloud') }}:
+      - checkout: 'git://Pipeline/common-ci@${{ parameters.commonCiRef }}'
+    - ${{ if ne(parameters.project, 'cloud') }}:
+      - checkout: 'git://$(System.TeamProject)/common-ci@${{ parameters.commonCiRef }}'
+
+    - task: PowerShell@2
+      inputs:
+        targetType: 'inline'
+        script: |
+          # Get the project names or IDs from parameters
+          $depTeamProjectName = "${{ parameters.depTeamProjectName }}"
+          $prTeamProjectName = "${{ parameters.prTeamProjectName }}"
+
+          # If the parameters are not set then use the default which should be
+          # the current project.
+          if(-not $depTeamProjectName -or '' -eq $depTeamProjectName){
+            $depTeamProjectName = "$(System.TeamProjectId)"
+          }
+
+          if(-not $prTeamProjectName -or '' -eq $prTeamProjectName){
+            $prTeamProjectName = "$(System.TeamProjectId)"
+          }
+          
+          # Set project name variables for use in later steps
+          echo "##vso[task.setvariable variable=depTeamProjectName]$depTeamProjectName"
+          echo "##vso[task.setvariable variable=prTeamProjectName]$prTeamProjectName"
+      name: DefaultProjectNames
+      
+    - powershell: |
+        # Install all modules
+        $Env:PSModulePath += ";$($(Get-Location).Path)\common-ci\scripts\modules"
+        Write-Host "Module Path: $($Env:PsModulePath)"
+        
+        # Get release-config.json path
+        $configFile = "$($(Get-Location).Path)\common-ci\${{ parameters.releaseConfigFile }}"
+        
+        # Cancel any previous builds
+        Write-Host ""
+        Write-Host "# Cancel the previous builds"
+        Write-Host "============================"
+        Write-Host "Pipeline: " + $Env:BUILD_DEFINITIONNAME
+        Write-Host "Branch: " + $Env:BUILD_SOURCEBRANCH
+        Write-Host "Current Build ID: " + $Env:BUILD_BUILDID
+        if (!$(Stop-PreviousBuilds `
+            -PipelineName $Env:BUILD_DEFINITIONNAME `
+            -Branch $Env:BUILD_SOURCEBRANCH `
+            -CurrentBuildId $Env:BUILD_BUILDID `
+            -TeamProjectName $(prTeamProjectName))) {
+            Write-Host "# ERROR: Failed to cancel the previous builds."
+            exit 1
+        }
+        
+        # Update all submodule.
+        cd $Env:BUILD_REPOSITORY_NAME
+        Write-Host "# Try to update repository $Env:BUILD_REPOSITORY_NAME."
+        if (!$(Update-CommitPushPull `
+            -ConfigFile $configFile `
+            -DepTeamProjectName $(depTeamProjectName) `
+            -PrTeamProjectName $(prTeamProjectName))) {
+            Write-Host "# ERROR: Failed to update submodule references and package dependencies."
+            exit 1
+        }
+      displayName: 'Submodule trigger'
+      workingDirectory: $(build.sourcesDirectory)
+      env:
+        SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+      condition: and(succeeded(), eq(variables['AutomatedRelease'], 'On'))

package/ci/common-ci/shared-variables.yml

@@ -0,0 +1,3 @@
+variables:
+- name: linuxImage
+  value: 'ubuntu-18.04'

package/ci/common-ci/trigger-release-apis.yml

@@ -0,0 +1,39 @@
+trigger: none
+
+pr: none
+
+variables:
+- group: CIAutomation # Required to access CI variables
+
+stages:
+- stage: Trigger_Release
+
+  jobs:
+  - job: Trigger_Release
+  
+    pool:
+      vmImage: 'windows-2019'
+  
+    steps:
+    - checkout: self
+      submodules: recursive
+      persistCredentials: true
+    
+    # This step should only be triggered if 'AutomatedRelease'
+    # variable is set to 'On'.
+    - powershell: |
+        # Install all modules
+        $Env:PSModulePath += ";$($(Get-Location).Path)\scripts\modules"
+        Write-Host "Module Path: $($Env:PsModulePath)"
+      
+        # Trigger the release
+        if (!$(Start-Release `
+            -ConfigFile "$($(Get-Location).Path)\release-config.json" `
+            -TeamProjectName $Env:SYSTEM_TEAMPROJECTID)) {
+            Write-Host "# Failed to trigger release of all apis."
+            exit 1
+        }
+      displayName: 'Trigger release'
+      env:
+        SYSTEM_ACCESSTOKEN: $(System.AccessToken)
+      condition: and(succeeded(), eq(variables['AutomatedRelease'], 'On'))