update list and vcs command (#270)

Author: jeffmccollum

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.1](https://github.com/hashicorp-services/tfm/compare/v0.11.0...v0.11.1) (2025-01-24)
+
+### Features
+
+- Update the `list vcs` command and the `copy workspaces --vcs`  flag to support GitHub App connections instead  of only support OAuth VCS connections. [[#268](https://github.com/hashicorp-services/tfm/issues/268)]
+
 ## [0.11.0](https://github.com/hashicorp-services/tfm/compare/v0.10.0...v0.11.0) (2025-01-10)
 
 ### Features

cmd/copy/workspaces-vcs.go

@@ -33,7 +33,7 @@ func configureVCSsettings(c tfclient.ClientContexts, org string, vcsOptions tfe.
 // Main function for --vcs flag
 func createVCSConfiguration(c tfclient.ClientContexts, vcsConfig map[string]string) error {
 
-	// for each `source-ot-ID=dest-ot-ID` string in the map, define the source oauth-ID and the target oauth-ID
+	// for each `source-ot-ID=dest-ot-ID` string in the map, define the source vcs ID and the target vcs ID
 	for key, element := range vcsConfig {
 		srcvcs := key
 		destvcs := element
@@ -50,9 +50,9 @@ func createVCSConfiguration(c tfclient.ClientContexts, vcsConfig map[string]stri
 			fmt.Println("Invalid input for workspaces-map")
 		}
 
-		// For each source workspace with a VCS connection, compare the source oauth ID to the
-		// user provided oauth ID. If they match, update the destination workspace with
-		// the user provided oauth ID that exists in the destination.
+		// For each source workspace with a VCS connection, compare the source ID to the
+		// user provided ID. If they match, update the destination workspace with
+		// the user provided ID that exists in the destination.
 		for _, ws := range srcWorkspaces {
 			destWorkSpaceName := ws.Name
 
@@ -66,24 +66,50 @@ func createVCSConfiguration(c tfclient.ClientContexts, vcsConfig map[string]stri
 				o.AddMessageUserProvided("No VCS ID Assigned to source Workspace: ", ws.Name)
 			} else {
 
-				// If the source Workspace assigned VCS does not match the one provided by the user on the left side of the `vcs-map`, do nothing and inform the user
-				if ws.VCSRepo.OAuthTokenID != srcvcs {
-					o.AddFormattedMessageUserProvided2("Workspace %v configured VCS ID does not match provided source ID %v. Skipping.", ws.Name, srcvcs)
-
-					// If the source Workspace assigned VCS matches the one provided by the user on the left side of the `vcs-map`, update the destination Workspace
-					// with the VCS provided by the user on the right side of the `vcs-map`
-				} else {
-					o.AddFormattedMessageUserProvided2("Updating destination Workspace %v VCS Settings and OauthID %v", destWorkSpaceName, destvcs)
-
-					vcsConfig := tfe.VCSRepoOptions{
-						Branch:            &ws.VCSRepo.Branch,
-						Identifier:        &ws.VCSRepo.Identifier,
-						IngressSubmodules: &ws.VCSRepo.IngressSubmodules,
-						OAuthTokenID:      &destvcs,
-						TagsRegex:         &ws.VCSRepo.TagsRegex,
+				if ws.VCSRepo.OAuthTokenID != "" {
+
+					// If the source Workspace assigned VCS does not match the one provided by the user on the left side of the `vcs-map`, do nothing and inform the user
+					if ws.VCSRepo.OAuthTokenID != srcvcs {
+						o.AddFormattedMessageUserProvided2("Workspace %v configured VCS ID does not match provided source ID %v. Skipping.", ws.Name, srcvcs)
+
+						// If the source Workspace assigned VCS matches the one provided by the user on the left side of the `vcs-map`, update the destination Workspace
+						// with the VCS provided by the user on the right side of the `vcs-map`
+					} else {
+						o.AddFormattedMessageUserProvided2("Updating destination Workspace %v VCS Settings %v", destWorkSpaceName, destvcs)
+
+						vcsConfig := tfe.VCSRepoOptions{
+							Branch:            &ws.VCSRepo.Branch,
+							Identifier:        &ws.VCSRepo.Identifier,
+							IngressSubmodules: &ws.VCSRepo.IngressSubmodules,
+							OAuthTokenID:      &destvcs,
+							TagsRegex:         &ws.VCSRepo.TagsRegex,
+						}
+
+						configureVCSsettings(c, c.DestinationOrganizationName, vcsConfig, destWorkSpaceName)
 					}
+				}
 
-					configureVCSsettings(c, c.DestinationOrganizationName, vcsConfig, destWorkSpaceName)
+				if ws.VCSRepo.GHAInstallationID != "" {
+
+					// If the source Workspace assigned VCS does not match the one provided by the user on the left side of the `vcs-map`, do nothing and inform the user
+					if ws.VCSRepo.GHAInstallationID != srcvcs {
+						o.AddFormattedMessageUserProvided2("Workspace %v configured VCS ID does not match provided source ID %v. Skipping.", ws.Name, srcvcs)
+
+						// If the source Workspace assigned VCS matches the one provided by the user on the left side of the `vcs-map`, update the destination Workspace
+						// with the VCS provided by the user on the right side of the `vcs-map`
+					} else {
+						o.AddFormattedMessageUserProvided2("Updating destination Workspace %v VCS Settings %v", destWorkSpaceName, destvcs)
+
+						vcsConfig := tfe.VCSRepoOptions{
+							Branch:            &ws.VCSRepo.Branch,
+							Identifier:        &ws.VCSRepo.Identifier,
+							IngressSubmodules: &ws.VCSRepo.IngressSubmodules,
+							GHAInstallationID: &destvcs,
+							TagsRegex:         &ws.VCSRepo.TagsRegex,
+						}
+
+						configureVCSsettings(c, c.DestinationOrganizationName, vcsConfig, destWorkSpaceName)
+					}
 				}
 			}
 		}

cmd/copy/workspaces.go

@@ -138,7 +138,7 @@ func init() {
 	}
 	workspacesCopyCmd.Flags().BoolVarP(&teamaccess, "teamaccess", "", false, "Copy workspace Team Access")
 	workspacesCopyCmd.Flags().BoolVarP(&agents, "agents", "", false, "Mapping of source Agent Pool IDs to destination Agent Pool IDs in config file")
-	workspacesCopyCmd.Flags().BoolVarP(&vcs, "vcs", "", false, "Mapping of source vcs Oauth ID to destination vcs Oath in config file")
+	workspacesCopyCmd.Flags().BoolVarP(&vcs, "vcs", "", false, "Mapping of source vcs Oauth ID or GitHub App ID to destination vcs Oauth or GitHub App ID in config file")
 	workspacesCopyCmd.Flags().BoolVarP(&ssh, "ssh", "", false, "Mapping of source ssh id to destination ssh id in config file")
 	workspacesCopyCmd.Flags().BoolVarP(&lock, "lock", "", false, "Lock all source workspaces")
 	workspacesCopyCmd.Flags().BoolVarP(&unlock, "unlock", "", false, "Unlock all source workspaces")

cmd/generate/config.go

@@ -48,9 +48,10 @@ dst_tfc_org=""
 dst_tfc_token="Must have owner permissions"
 #dst_tfc_project_id=""
 
-# A list of source=destination VCS oauth IDs. TFM will look at each workspace in the source for the source VCS oauth ID and assign the matching workspace in the destination with the destination VCS oauth ID.
+# A list of source=destination VCS IDs. TFM will look at each workspace in the source for the source VCS ID and assign the matching workspace in the destination with the destination VCS ID.
 #vcs-map=[
 #  "ot-wF6KZMna4desiPRc=ot-JSQTcnWxqVL5zQ1w",
+#  "ghain-sc8a3b12S212gy45=ghain-B3asgvX3oF541aDo"
 #]
 
 

cmd/list/vcs.go

@@ -38,11 +38,18 @@ func init() {
 }
 
 // helper functions
-func vcsListAllForOrganization(c tfclient.ClientContexts, orgName string) ([]*tfe.OAuthClient, error) {
+func vcsListAllForOrganization(c tfclient.ClientContexts, orgName string) ([]*tfe.OAuthClient, []*tfe.GHAInstallation, error) {
 	var allItems []*tfe.OAuthClient
+	var allGHAItems []*tfe.GHAInstallation
+
+	optsGHA := tfe.GHAInstallationListOptions{
+		ListOptions: tfe.ListOptions{PageNumber: 1, PageSize: 100},
+	}
+
 	opts := tfe.OAuthClientListOptions{
 		ListOptions: tfe.ListOptions{PageNumber: 1, PageSize: 100},
 	}
+
 	for {
 		var items *tfe.OAuthClientList
 		var err error
@@ -55,7 +62,7 @@ func vcsListAllForOrganization(c tfclient.ClientContexts, orgName string) ([]*tf
 			items, err = c.DestinationClient.OAuthClients.List(c.DestinationContext, orgName, &opts)
 		}
 		if err != nil {
-			return nil, err
+			return nil, nil, err
 		}
 
 		allItems = append(allItems, items.Items...)
@@ -66,7 +73,31 @@ func vcsListAllForOrganization(c tfclient.ClientContexts, orgName string) ([]*tf
 		opts.PageNumber = items.NextPage
 	}
 
-	return allItems, nil
+	for {
+		var ghaItems *tfe.GHAInstallationList
+		var err error
+
+		if (ListCmd.Flags().Lookup("side").Value.String() == "source") || (!ListCmd.Flags().Lookup("side").Changed) {
+			ghaItems, err = c.SourceClient.GHAInstallations.List(c.SourceContext, &optsGHA)
+		}
+
+		if ListCmd.Flags().Lookup("side").Value.String() == "destination" {
+			ghaItems, err = c.DestinationClient.GHAInstallations.List(c.DestinationContext, &optsGHA)
+		}
+		if err != nil {
+			return nil, nil, err
+		}
+
+		allGHAItems = append(allGHAItems, ghaItems.Items...)
+
+		if ghaItems.CurrentPage >= ghaItems.TotalPages {
+			break
+		}
+		opts.PageNumber = ghaItems.NextPage
+
+	}
+
+	return allItems, allGHAItems, nil
 }
 
 func organizationListAll(c tfclient.ClientContexts) ([]*tfe.Organization, error) {
@@ -123,27 +154,35 @@ func vcsListAll(c tfclient.ClientContexts) error {
 	}
 
 	var allVcsList []*tfe.OAuthClient
+	var allGhaList []*tfe.GHAInstallation
 
 	for _, v := range allOrgs {
-		vcsList, err := vcsListAllForOrganization(c, v.Name)
+		vcsList, ghaList, err := vcsListAllForOrganization(c, v.Name)
 		if err != nil {
 			helper.LogError(err, "failed to list vcs for organization")
 		}
 
 		allVcsList = append(allVcsList, vcsList...)
+		allGhaList = append(allGhaList, ghaList...)
 	}
 
-	o.AddFormattedMessageCalculated("Found %d vcs", len(allVcsList))
+	o.AddFormattedMessageCalculated("Found %d OAuth vcs connections", len(allVcsList))
+	o.AddFormattedMessageCalculated("Found %d GHA vcs connections", len(allVcsList))
 
-	o.AddTableHeaders("Organization", "Name", "Id", "Service Provider", "Service Provider Name", "Created At", "URL")
+	o.AddTableHeaders("Organization", "Name", "Id",  "Service Provider", "Service Provider Name", "Created At", "URL")
 	for _, i := range allVcsList {
 
 		vcsName := ""
 		if i.Name != nil {
 			vcsName = *i.Name
 		}
 
-		o.AddTableRows(i.Organization.Name, vcsName, i.OAuthTokens[0].ID, i.ServiceProvider, i.ServiceProviderName, i.CreatedAt, i.HTTPURL)
+		o.AddTableRows(i.Organization.Name, vcsName, i.OAuthTokens[0].ID ,i.ServiceProvider, i.ServiceProviderName, i.CreatedAt, i.HTTPURL)
+	}
+
+
+	for _, i := range allGhaList {
+		o.AddTableRows("", *i.Name, *i.ID, "github", "GitHub App", "", "")
 	}
 
 	return nil
@@ -153,23 +192,26 @@ func vcsList(c tfclient.ClientContexts) error {
 	o.AddMessageUserProvided("List vcs for configured Organizations", "")
 
 	var orgVcsList []*tfe.OAuthClient
+	var orgGhaList []*tfe.GHAInstallation
 	var err error
 
 	if (ListCmd.Flags().Lookup("side").Value.String() == "source") || (!ListCmd.Flags().Lookup("side").Changed) {
-		orgVcsList, err = vcsListAllForOrganization(c, c.SourceOrganizationName)
+		orgVcsList, orgGhaList, err = vcsListAllForOrganization(c, c.SourceOrganizationName)
 	}
 
 	if ListCmd.Flags().Lookup("side").Value.String() == "destination" {
-		orgVcsList, err = vcsListAllForOrganization(c, c.DestinationOrganizationName)
+		orgVcsList, orgGhaList, err = vcsListAllForOrganization(c, c.DestinationOrganizationName)
 	}
 
 	if err != nil {
 		helper.LogError(err, "failed to list vcs for organization")
 	}
 
-	o.AddFormattedMessageCalculated("Found %d vcs", len(orgVcsList))
+	
+	o.AddFormattedMessageCalculated("Found %d OAuth vcs connections", len(orgVcsList))
+	o.AddFormattedMessageCalculated("Found %d GHA vcs connections", len(orgGhaList))
 
-	o.AddTableHeaders("Organization", "Name", "Id", "Service Provider", "Service Provider Name", "Created At", "URL")
+	o.AddTableHeaders("Organization", "Name", "Id",  "Service Provider", "Service Provider Name", "Created At", "URL")
 	for _, i := range orgVcsList {
 
 		vcsName := ""
@@ -180,5 +222,9 @@ func vcsList(c tfclient.ClientContexts) error {
 		o.AddTableRows(i.Organization.Name, vcsName, i.OAuthTokens[0].ID, i.ServiceProvider, i.ServiceProviderName, i.CreatedAt, i.HTTPURL)
 	}
 
+	for _, i := range orgGhaList {
+		o.AddTableRows("", *i.Name, *i.ID, "github", "GitHub App", "", "")
+	}
+
 	return nil
 }

tfe-migration.md

@@ -92,13 +92,14 @@ varsets-map = [
 
 ## Assign VCS
 
-As part of the HCL config file (`/home/user/.tfm.hcl`), a list of `source-vcs-oauth-ID=destination-vcs-oauth-id-ID` can be provided. `tfm` will use this list when running `tfm copy workspaces --vcs` to look at all workspaces in the source host with the assigned source VCS oauth ID and assign the matching named workspace in the destination with the mapped destination VCS oauth ID.
+As part of the HCL config file (`/home/user/.tfm.hcl`), a list of vcs mappings of either `source-vcs-oauth-id=destination-vcs-oauth-id` or `source-vcs-github-app-id=destination-vcs-github-app-id` can be provided. `tfm` will use this list when running `tfm copy workspaces --vcs` to look at all workspaces in the source host with the assigned source VCS ID and assign the matching named workspace in the destination with the mapped destination VCS ID. `tfm` only supports like for like vcs migration, so if the source is a GitHub App VCS connection the destination must use a GitHub App VCS connection.
 
 ```hcl
-# A list of source=destination VCS oauth IDs. TFM will look at each workspace in the source for the source VCS oauth ID and assign the matching workspace in the destination with the destination VCS oauth ID.
+# A list of source=destination VCS IDs. TFM will look at each workspace in the source for the source VCS ID and assign the matching workspace in the destination with the destination VCS ID.
 vcs-map=[
   "ot-5uwu2Kq8mEyLFPzP=ot-coPDFTEr66YZ9X9n",
   "ot-gkj2An452kn2flfw=ot-8ALKBaqnvj232GB4",
+  "ghain-sc8a3b12S212gy45=ghain-B3asgvX3oF541aDo"
 ]
 ```