Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support localspecrepo if pass in this parameter #6272

Merged
merged 3 commits into from
Jun 6, 2023
Merged

Support localspecrepo if pass in this parameter #6272

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
942fc64
Support localspecrepo if pass in this parameter
raych1 Jun 1, 2023
651ea23
Support regen sdk code based on local typespecs
raych1 Jun 2, 2023
88e92f2
Added reference doc to error message
raych1 Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions eng/common/scripts/TypeSpec-Project-Generate.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ function NpmInstallForProject([string]$workingDirectory) {

#default to root/eng/emitter-package.json but you can override by writing
#Get-${Language}-EmitterPackageJsonPath in your Language-Settings.ps1
$replacementPackageJson = "$PSScriptRoot/../../emitter-package.json"
$replacementPackageJson = Join-Path $PSScriptRoot "../../emitter-package.json"
if (Test-Path "Function:$GetEmitterPackageJsonPathFn") {
$replacementPackageJson = &$GetEmitterPackageJsonPathFn
}
Expand All @@ -52,7 +52,7 @@ function NpmInstallForProject([string]$workingDirectory) {
Write-Host "Package.json contains '-alpha.' in the version, Creating .npmrc using public/azure-sdk-for-js-test-autorest feed."
"registry=https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-js-test-autorest/npm/registry/ `n`nalways-auth=true" | Out-File '.npmrc'
}

npm install --no-lock-file
if ($LASTEXITCODE) { exit $LASTEXITCODE }
}
Expand Down Expand Up @@ -112,3 +112,4 @@ $shouldCleanUp = !$SaveInputs
if ($shouldCleanUp) {
Remove-Item $tempFolder -Recurse -Force
}
exit 0
91 changes: 57 additions & 34 deletions eng/common/scripts/TypeSpec-Project-Process.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,20 @@ param (
Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module

function CreateUpdate-TspLocation([System.Object]$tspConfig, [string]$TypeSpecProjectDirectory, [string]$CommitHash, [string]$repo, [string]$repoRoot) {
$serviceDir = ""
$additionalDirs = @()

# Parse tspcofig.yaml to get service-dir, additionalDirectories, and package-dir
if ($tspConfig["parameters"] -and $tspConfig["parameters"]["service-dir"]) {
$serviceDir = $tspConfig["parameters"]["service-dir"]["default"];
}
else {
Write-Error "Missing service-dir in parameters section of tspconfig.yaml."
exit 1
}
if ($tspConfig["parameters"]["dependencies"] -and $tspConfig["parameters"]["dependencies"]["additionalDirectories"]) {
$additionalDirs = $tspConfig["parameters"]["dependencies"]["additionalDirectories"];
}

$packageDir = Get-PackageDir $tspConfig

# Create service-dir if not exist
$serviceDir = Join-Path $repoRoot $serviceDir
$serviceDir = Get-ServiceDir $tspConfig $repoRoot
if (!(Test-Path -Path $serviceDir)) {
New-Item -Path $serviceDir -ItemType Directory | Out-Null
Write-Host "created service folder $serviceDir"
}

# Create package-dir if not exist
$packageDir = Get-PackageDir $tspConfig
$packageDir = Join-Path $serviceDir $packageDir
if (!(Test-Path -Path $packageDir)) {
New-Item -Path $packageDir -ItemType Directory | Out-Null
Expand Down Expand Up @@ -71,6 +60,20 @@ function CreateUpdate-TspLocation([System.Object]$tspConfig, [string]$TypeSpecPr
return $packageDir
}

function Get-ServiceDir([System.Object]$tspConfig, [string]$repoRoot) {
$serviceDir = ""
if ($tspConfig["parameters"] -and $tspConfig["parameters"]["service-dir"]) {
$serviceDir = $tspConfig["parameters"]["service-dir"]["default"];
}
else {
Write-Error "Missing service-dir in parameters section of tspconfig.yaml."
raych1 marked this conversation as resolved.
Show resolved Hide resolved
exit 1
}

# Create service-dir if not exist
$serviceDir = Join-Path $repoRoot $serviceDir
return $serviceDir
}
function Get-PackageDir([System.Object]$tspConfig) {
$emitterName = ""
if (Test-Path "Function:$GetEmitterNameFn") {
Expand All @@ -91,12 +94,21 @@ function Get-PackageDir([System.Object]$tspConfig) {
return $packageDir
}

$repoRootPath = (Join-Path $PSScriptRoot .. .. ..)
$repoRootPath = Resolve-Path $repoRootPath
$repoRootPath = $repoRootPath -replace "\\", "/"
$tspConfigPath = Join-Path $repoRootPath 'tspconfig.yaml'
function Get-TspLocationFolder([System.Object]$tspConfig, [string]$repoRoot) {
$serviceDir = Get-ServiceDir $tspConfig $repoRoot
$packageDir = Get-PackageDir $tspConfig
$packageDir = Join-Path $serviceDir $packageDir
return $packageDir
}

$sdkRepoRootPath = (Join-Path $PSScriptRoot .. .. ..)
$sdkRepoRootPath = Resolve-Path $sdkRepoRootPath
$sdkRepoRootPath = $sdkRepoRootPath -replace "\\", "/"
$tspConfigPath = Join-Path $sdkRepoRootPath 'tspconfig.yaml'
$tmpTspConfigPath = $tspConfigPath
$repo = ""
$specRepoRoot = ""
$generateFromLocalTypeSpec = $false
# remote url scenario
# example url of tspconfig.yaml: https://github.com/Azure/azure-rest-api-specs-pr/blob/724ccc4d7ef7655c0b4d5c5ac4a5513f19bbef35/specification/containerservice/Fleet.Management/tspconfig.yaml
if ($TypeSpecProjectDirectory -match '^https://github.com/(?<repo>Azure/azure-rest-api-specs(-pr)?)/blob/(?<commit>[0-9a-f]{40})/(?<path>.*)/tspconfig.yaml$') {
Expand All @@ -121,26 +133,26 @@ if ($TypeSpecProjectDirectory -match '^https://github.com/(?<repo>Azure/azure-re
exit 1
}
$TypeSpecProjectDirectory = $TypeSpecProjectDirectory.Replace("\", "/")
if ($TypeSpecProjectDirectory -match "^.*/(?<path>specification/.*)$") {
if ($TypeSpecProjectDirectory -match "(?<repoRoot>^.*)/(?<path>specification/.*)$") {
$TypeSpecProjectDirectory = $Matches["path"]
$specRepoRoot = $Matches["repoRoot"]
} else {
Write-Error "$TypeSpecProjectDirectory doesn't have 'specification' in path."
exit 1
}
if (!$CommitHash) {
Write-Error "Parameter of Commithash is not provided in the local path scenario."
exit 1
}
if (!$RepoUrl) {
Write-Error "Parameter of RepoUrl:$RepoUrl is not provided in the local path scenario."
exit 1
}
if ($RepoUrl -match "^https://github.com/(?<repo>[^/]*/azure-rest-api-specs(-pr)?).*") {
$repo = $Matches["repo"]
if (!$CommitHash -or !$RepoUrl) {
Write-Warning "Parameter of Commithash or RepoUrl are not provided along with the local path of tspconfig.yaml, trying to re-generate sdk code based on the local type specs."
$generateFromLocalTypeSpec = $true
}
else {
Write-Error "Parameter 'RepoUrl' has incorrect value:$RepoUrl. It should be similar like 'https://github.com/Azure/azure-rest-api-specs'"
exit 1

if ($RepoUrl) {
if ($RepoUrl -match "^https://github.com/(?<repo>[^/]*/azure-rest-api-specs(-pr)?).*") {
$repo = $Matches["repo"]
}
else {
Write-Error "Parameter 'RepoUrl' has incorrect value:$RepoUrl. It should be similar like 'https://github.com/Azure/azure-rest-api-specs'"
exit 1
}
}
}

Expand All @@ -150,12 +162,23 @@ $tspConfigYaml = Get-Content $tspConfigPath -Raw | ConvertFrom-Yaml
if (Test-Path $tmpTspConfigPath) {
Remove-Item $tspConfigPath
}
# call CreateUpdate-TspLocation function
$sdkProjectFolder = CreateUpdate-TspLocation $tspConfigYaml $TypeSpecProjectDirectory $CommitHash $repo $repoRootPath

$sdkProjectFolder = ""
if ($generateFromLocalTypeSpec) {
$sdkProjectFolder = Get-TspLocationFolder $tspConfigYaml $sdkRepoRootPath
$tspLocationYamlPath = Join-Path $sdkProjectFolder "tsp-location.yaml"
if (!(Test-Path -Path $tspLocationYamlPath)) {
Write-Error "Failed to find tsp-location.yaml in '$sdkProjectFolder', please make sure to provide CommitHash and RepoUrl parameters along with the local path of tspconfig.yaml in order to create tsp-location.yaml."
exit 1
}
} else {
# call CreateUpdate-TspLocation function
$sdkProjectFolder = CreateUpdate-TspLocation $tspConfigYaml $TypeSpecProjectDirectory $CommitHash $repo $sdkRepoRootPath
}

# call TypeSpec-Project-Sync.ps1
$syncScript = Join-Path $PSScriptRoot TypeSpec-Project-Sync.ps1
& $syncScript $sdkProjectFolder
& $syncScript $sdkProjectFolder $specRepoRoot
if ($LASTEXITCODE) { exit $LASTEXITCODE }

# call TypeSpec-Project-Generate.ps1
Expand Down
182 changes: 101 additions & 81 deletions eng/common/scripts/TypeSpec-Project-Sync.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

[CmdletBinding()]
param (
[Parameter(Position=0)]
[ValidateNotNullOrEmpty()]
[string] $ProjectDirectory
[Parameter(Position = 0)]
[ValidateNotNullOrEmpty()]
[string] $ProjectDirectory,
[Parameter(Position = 1)]
[string] $LocalSpecRepoPath
)

$ErrorActionPreference = "Stop"
Expand All @@ -13,115 +15,133 @@ Install-ModuleIfNotInstalled "powershell-yaml" "0.4.1" | Import-Module
$sparseCheckoutFile = ".git/info/sparse-checkout"

function AddSparseCheckoutPath([string]$subDirectory) {
if (!(Test-Path $sparseCheckoutFile) -or !((Get-Content $sparseCheckoutFile).Contains($subDirectory))) {
Write-Output $subDirectory >> .git/info/sparse-checkout
}
if (!(Test-Path $sparseCheckoutFile) -or !((Get-Content $sparseCheckoutFile).Contains($subDirectory))) {
Write-Output $subDirectory >> .git/info/sparse-checkout
}
}

function CopySpecToProjectIfNeeded([string]$specCloneRoot, [string]$mainSpecDir, [string]$dest, [string[]]$specAdditionalSubDirectories) {
$source = "$specCloneRoot/$mainSpecDir"
Copy-Item -Path $source -Destination $dest -Recurse -Force
Write-Host "Copying spec from $source to $dest"
$source = Join-Path $specCloneRoot $mainSpecDir
Copy-Item -Path $source -Destination $dest -Recurse -Force
Write-Host "Copying spec from $source to $dest"

foreach ($additionalDir in $specAdditionalSubDirectories) {
$source = "$specCloneRoot/$additionalDir"
Write-Host "Copying spec from $source to $dest"
Copy-Item -Path $source -Destination $dest -Recurse -Force
}
foreach ($additionalDir in $specAdditionalSubDirectories) {
$source = Join-Path $specCloneRoot $additionalDir
Write-Host "Copying spec from $source to $dest"
Copy-Item -Path $source -Destination $dest -Recurse -Force
}
}

function UpdateSparseCheckoutFile([string]$mainSpecDir, [string[]]$specAdditionalSubDirectories) {
AddSparseCheckoutPath $mainSpecDir
foreach ($subDir in $specAdditionalSubDirectories) {
AddSparseCheckoutPath $subDir
}
AddSparseCheckoutPath $mainSpecDir
foreach ($subDir in $specAdditionalSubDirectories) {
Write-Host "Adding $subDir to sparse checkout"
AddSparseCheckoutPath $subDir
}
}

function GetGitRemoteValue([string]$repo) {
Push-Location $ProjectDirectory
$result = ""
try {
$gitRemotes = (git remote -v)
foreach ($remote in $gitRemotes) {
if ($remote.StartsWith("origin")) {
if ($remote -match 'https://github.com/\S+') {
$result = "https://github.com/$repo.git"
break
} elseif ($remote -match "[email protected]:\S+"){
$result = "[email protected]:$repo.git"
break
} else {
throw "Unknown git remote format found: $remote"
}
}
Push-Location $ProjectDirectory
$result = ""
try {
$gitRemotes = (git remote -v)
foreach ($remote in $gitRemotes) {
Write-Host "Checking remote $remote"
if ($remote.StartsWith("origin") -or $remote.StartsWith("main")) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What context do we need to support "main" as a remote?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the remotes in the pipeline run of test repo which doesn't have origin. That's why I added main.

10:29:05.890 cmdout 	[generate.py] Checking remote integration	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (fetch)
10:29:05.891 cmdout 	[generate.py] Checking remote integration	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (push)
10:29:05.891 cmdout 	[generate.py] Checking remote main	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (fetch)
10:29:05.891 cmdout 	[generate.py] Checking remote main	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (push)
10:29:05.891 cmdout 	[generate.py] Checking remote secondary	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (fetch)
10:29:05.892 cmdout 	[generate.py] Checking remote secondary	https://x-access-token:***@github.com/openapi-env-test/azure-sdk-for-java (push)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK the automation pipeline must be doing something unique when it does its clones as by default origin is always set to what is cloned.

if ($remote -match 'https://(.*)?github.com/\S+') {
$result = "https://github.com/$repo.git"
break
}
elseif ($remote -match "(.*)[email protected]:\S+") {
$result = "[email protected]:$repo.git"
break
}
else {
throw "Unknown git remote format found: $remote"
}
}
}
finally {
Pop-Location
}

return $result
}
finally {
Pop-Location
}
Write-Host "Found git remote $result"
return $result
}

function InitializeSparseGitClone([string]$repo) {
git clone --no-checkout --filter=tree:0 $repo .
if ($LASTEXITCODE) { exit $LASTEXITCODE }
git sparse-checkout init
if ($LASTEXITCODE) { exit $LASTEXITCODE }
Remove-Item $sparseCheckoutFile -Force
git clone --no-checkout --filter=tree:0 $repo .
if ($LASTEXITCODE) { exit $LASTEXITCODE }
git sparse-checkout init
if ($LASTEXITCODE) { exit $LASTEXITCODE }
Remove-Item $sparseCheckoutFile -Force
}

function GetSpecCloneDir([string]$projectName) {
Push-Location $ProjectDirectory
try {
$root = git rev-parse --show-toplevel
}
finally {
Pop-Location
}

$sparseSpecCloneDir = "$root/../sparse-spec/$projectName"
New-Item $sparseSpecCloneDir -Type Directory -Force | Out-Null
$createResult = Resolve-Path $sparseSpecCloneDir
return $createResult
Push-Location $ProjectDirectory
try {
$root = git rev-parse --show-toplevel
}
finally {
Pop-Location
}

$sparseSpecCloneDir = "$root/../sparse-spec/$projectName"
New-Item $sparseSpecCloneDir -Type Directory -Force | Out-Null
$createResult = Resolve-Path $sparseSpecCloneDir
return $createResult
}

$typespecConfigurationFile = Resolve-Path "$ProjectDirectory/tsp-location.yaml"
Write-Host "Reading configuration from $typespecConfigurationFile"
$configuration = Get-Content -Path $typespecConfigurationFile -Raw | ConvertFrom-Yaml

$pieces = $typespecConfigurationFile.Path.Replace("\","/").Split("/")
$pieces = $typespecConfigurationFile.Path.Replace("\", "/").Split("/")
$projectName = $pieces[$pieces.Count - 2]

$specSubDirectory = $configuration["directory"]

if ( $configuration["repo"] -and $configuration["commit"]) {
$specCloneDir = GetSpecCloneDir $projectName
$gitRemoteValue = GetGitRemoteValue $configuration["repo"]

Write-Host "Setting up sparse clone for $projectName at $specCloneDir"

Push-Location $specCloneDir.Path
try {
if (!(Test-Path ".git")) {
InitializeSparseGitClone $gitRemoteValue
}
UpdateSparseCheckoutFile $specSubDirectory $configuration["additionalDirectories"]
git checkout $configuration["commit"]
if ($LASTEXITCODE) { exit $LASTEXITCODE }
}
finally {
Pop-Location
# use local spec repo if provided
if ($LocalSpecRepoPath) {
$specCloneDir = $LocalSpecRepoPath
raych1 marked this conversation as resolved.
Show resolved Hide resolved
}
elseif ($configuration["repo"] -and $configuration["commit"]) {
# use sparse clone if repo and commit are provided
$specCloneDir = GetSpecCloneDir $projectName
$gitRemoteValue = GetGitRemoteValue $configuration["repo"]

Write-Host "from tsplocation.yaml 'repo' is:"$configuration["repo"]
Write-Host "Setting up sparse clone for $projectName at $specCloneDir"

Push-Location $specCloneDir.Path
try {
if (!(Test-Path ".git")) {
Write-Host "Initializing sparse clone for repo: $gitRemoteValue"
InitializeSparseGitClone $gitRemoteValue
}
} elseif ( $configuration["spec-root-dir"] ) {
$specCloneDir = $configuration["spec-root-dir"]
Write-Host "Updating sparse checkout file with directory:$specSubDirectory"
UpdateSparseCheckoutFile $specSubDirectory $configuration["additionalDirectories"]
$commit = $configuration["commit"]
Write-Host "git checkout commit: $commit"
git checkout $configuration["commit"]
if ($LASTEXITCODE) { exit $LASTEXITCODE }
}
finally {
Pop-Location
}
}
else {
# write error if neither local spec repo nor repo and commit are provided
Write-Error "Must contain both 'repo' and 'commit' in tsp-location.yaml or input 'localSpecRepoPath' parameter."
exit 1
}


$tempTypeSpecDir = "$ProjectDirectory/TempTypeSpecFiles"
New-Item $tempTypeSpecDir -Type Directory -Force | Out-Null
CopySpecToProjectIfNeeded `
-specCloneRoot $specCloneDir `
-mainSpecDir $specSubDirectory `
-dest $tempTypeSpecDir `
-specAdditionalSubDirectories $configuration["additionalDirectories"]
-specCloneRoot $specCloneDir `
-mainSpecDir $specSubDirectory `
-dest $tempTypeSpecDir `
-specAdditionalSubDirectories $configuration["additionalDirectories"]

exit 0