Read the Team entity Identifier when reading team data (#226)

* Read the Team entity Identifier when reading team data

This is needed for the Users & Teams migration as entities will reference
teams by their identifier (not their names like before).

* Updated the old port_team example and added an example for port_team after migration

* updated docs

* Shuffle order of test files

* shorten package name for CI titles

Author: Eyal-Shalev

.github/workflows/ci.yml

@@ -50,18 +50,22 @@ jobs:
           import json
           import os
           import subprocess
+          from random import Random
           
           result = subprocess.run(("go", "list", "./..."), capture_output=True, text=True)
           assert result.returncode == 0, result.stderr
           packages: list[str] = list(filter(lambda x: x != '', result.stdout.split('\n')))
           files: list[str] = []
           include: list[dict[str, str]] = []
           for package in packages:
-            file = package.replace('/', '-').replace('.', '-') + ".test"
+            package_short = package.removeprefix('github.com/port-labs/terraform-provider-port-labs/')
+            file = package_short.replace('/', '-').replace('.', '-') + ".test"
             subprocess.run(("go", "test", package, "-c", "-o", file), capture_output=True, text=True, check=True)
             if os.path.isfile(file):
               files.append(file)
-              include.append(dict(test_file=file, package=package))
+              include.append(dict(test_file=file, package=package, package_short=package_short))
+            
+            Random(int("${{ github.run_id }}")).shuffle(files)
             json_files = json.dumps(files)
             with open(os.environ['GITHUB_OUTPUT'], 'a') as github_output:
               print(f'test_files=' + json.dumps(files), file=github_output)
@@ -74,7 +78,7 @@ jobs:
           if-no-files-found: error
 
   acctest:
-    name: Acceptance Test - ${{matrix.package}}
+    name: Test ${{matrix.package_short}}
     needs: acctest-build
     concurrency:
       group: acctest
@@ -98,7 +102,7 @@ jobs:
       - uses: actions/download-artifact@v4
         with:
           name: test-files
-      - name: Run tests - ${{matrix.package}}
+      - name: Test ${{ matrix.package }}
         env:
           TF_ACC: 1
           CI_USER_NAME: ${{ secrets.CI_USER_NAME }}
@@ -107,7 +111,8 @@ jobs:
           PORT_BASE_URL: ${{ secrets.PORT_BASE_URL }}
         run: |
           chmod u+x "${{matrix.test_file}}"
-          gotestsum --raw-command --format testname --junitfile "./test-results/${{matrix.test_file}}.xml" -- go tool test2json -t -p "${{matrix.package}}" "./${{matrix.test_file}}" \
+          gotestsum --raw-command --rerun-fails --format testname --junitfile "./test-results/${{matrix.test_file}}.xml" \
+            -- go tool test2json -t -p "${{matrix.package}}" "./${{matrix.test_file}}" \
             -test.v=test2json -test.timeout 10m -test.parallel 1 -test.shuffle "${{ github.run_id }}"
 
       - uses: actions/upload-artifact@v4
@@ -129,9 +134,12 @@ jobs:
           merge-multiple: 'true'
           path: 'test-results'
       - name: Publish Test Report
-        uses: mikepenz/action-junit-report@v4
+        uses: mikepenz/action-junit-report@v5
         with:
           report_paths: './test-results/*.xml'
-          include_passed: true
-          require_tests: true
-          fail_on_failure: true
+          include_passed: 'true'
+          require_tests: 'true'
+          fail_on_failure: 'true'
+          comment: 'true'
+          check_retries: 'true'
+          flaky_summary: 'true'

docs/resources/port_blueprint.md

@@ -287,7 +287,7 @@ resource "port_blueprint" "microservice" {
 - `ownership` (Attributes) Optional ownership field for Blueprint. 'type' can be Inherited or Direct. If 'Inherited', then 'path' is required and must be a valid relation identifiers path. (see [below for nested schema](#nestedatt--ownership))
 - `properties` (Attributes) The properties of the blueprint (see [below for nested schema](#nestedatt--properties))
 - `relations` (Attributes Map) The relations of the blueprint (see [below for nested schema](#nestedatt--relations))
-- `team_inheritance` (Attributes) The team inheritance of the blueprint (see [below for nested schema](#nestedatt--team_inheritance))
+- `team_inheritance` (Attributes, Deprecated) The team inheritance of the blueprint (see [below for nested schema](#nestedatt--team_inheritance))
 - `webhook_changelog_destination` (Attributes) The webhook changelog destination of the blueprint (see [below for nested schema](#nestedatt--webhook_changelog_destination))
 
 ### Read-Only

docs/resources/port_team.md

@@ -28,5 +28,6 @@ Team resource
 
 - `created_at` (String) The creation date of the team
 - `id` (String) The ID of this resource.
+- `identifier` (String) The machine-readable identifier of the _team entity
 - `provider_name` (String) The provider of the team
 - `updated_at` (String) The last update date of the team

examples/provider.tf

@@ -2,7 +2,7 @@ terraform {
   required_providers {
     port = {
       source  = "port-labs/port-labs"
-      version = "~> 2.0.0"
+      version = "~> 2"
     }
   }
 }

examples/resources/port_team/main.tf

@@ -0,0 +1,23 @@
+resource "port_team" "Example-Team" {
+  name        = "Example Team"
+  description = "An example team"
+  # Note, this will need real users to work!
+  users = [
+    "[email protected]",
+    "[email protected]",
+    "[email protected]",
+  ]
+}
+
+resource "port_blueprint" "some-blueprint" {
+  identifier = "some-blueprint"
+  title      = "Some Blueprint"
+}
+
+resource "port_entity" "some-entity" {
+  blueprint = port_blueprint.some-blueprint.identifier
+  title = "Some Entity"
+  teams = [
+    port_team.Example-Team.name,
+  ]
+}

examples/resources/port_team_v0/main.tf

@@ -0,0 +1,26 @@
+resource "port_team" "Example-Team" {
+  name        = "Example Team"
+  description = "An example team"
+  # Note, this will need real users to work!
+  users = [
+    "[email protected]",
+    "[email protected]",
+    "[email protected]",
+  ]
+}
+
+resource "port_blueprint" "some-blueprint" {
+  identifier = "some-blueprint"
+  title      = "Some Blueprint"
+  ownership = {
+    type = "Direct"
+  }
+}
+
+resource "port_entity" "some-entity" {
+  blueprint = port_blueprint.some-blueprint.identifier
+  title = "Some Entity"
+  teams = [
+    port_team.Example-Team.identifier,
+  ]
+}

examples/resources/port_team/provider.tf renamed to examples/resources/port_team_v0/provider.tf

@@ -0,0 +1 @@
+../../provider.tf

examples/resources/port_team_v2/main.tf

@@ -15,6 +15,7 @@ require (
 require (
 	github.com/ProtonMail/go-crypto v1.1.0-alpha.5-proton // indirect
 	github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
+	github.com/avast/retry-go/v4 v4.6.1
 	github.com/cloudflare/circl v1.3.9 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.34.0 // indirect

examples/resources/port_team_v2/provider.tf

@@ -21,6 +21,8 @@ github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmms
 github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
 github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI=
 github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=
+github.com/avast/retry-go/v4 v4.6.1 h1:VkOLRubHdisGrHnTu89g08aQEWEgRU7LVEop3GbIcMk=
+github.com/avast/retry-go/v4 v4.6.1/go.mod h1:V6oF8njAwxJ5gRo1Q7Cxab24xs5NCWZBeaHHBklR8mA=
 github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY=
 github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs=
 github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA=
@@ -195,8 +197,9 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
 github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
+github.com/stretchr/tetify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/vmihailenco/msgpack v3.3.3+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk=
 github.com/vmihailenco/msgpack v4.0.4+incompatible h1:dSLoQfGFAo3F6OoNhwUmLwVgaUXK79GlxNBwueZn0xI=
 github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk=

go.mod

@@ -3,19 +3,21 @@ package cli
 import (
 	"context"
 	"encoding/json"
+	"fmt"
+	"slices"
 	"strings"
 
 	"github.com/go-resty/resty/v2"
 )
 
-type (
-	Option     func(*PortClient)
-	PortClient struct {
-		Client   *resty.Client
-		ClientID string
-		Token    string
-	}
-)
+type Option func(*PortClient)
+
+type PortClient struct {
+	Client       *resty.Client
+	ClientID     string
+	Token        string
+	featureFlags []string
+}
 
 func New(baseURL string, opts ...Option) (*PortClient, error) {
 	c := &PortClient{
@@ -42,6 +44,32 @@ func New(baseURL string, opts ...Option) (*PortClient, error) {
 	return c, nil
 }
 
+// FeatureFlags Fetches the feature flags from the Organization API. It caches the feature flags locally to reduce call
+// count.
+func (c *PortClient) FeatureFlags(ctx context.Context) ([]string, error) {
+	if c.featureFlags == nil {
+		organization, _, err := c.ReadOrganization(ctx)
+		if err != nil {
+			return nil, fmt.Errorf("failed to read organization data: %w", err)
+		}
+		c.featureFlags = organization.FeatureFlags
+	}
+	return slices.Clone(c.featureFlags), nil
+}
+
+func (c *PortClient) HasFeatureFlags(ctx context.Context, flags ...string) (bool, error) {
+	orgFlags, err := c.FeatureFlags(ctx)
+	if err != nil {
+		return false, err
+	}
+	for _, flag := range flags {
+		if !slices.Contains(orgFlags, flag) {
+			return false, nil
+		}
+	}
+	return true, nil
+}
+
 func (c *PortClient) Authenticate(ctx context.Context, clientID, clientSecret string) (string, error) {
 	url := "v1/auth/access_token"
 	resp, err := c.Client.R().

go.sum

@@ -411,7 +411,7 @@ type (
 		Entity       *EntityProperty `json:"entity,omitempty"`
 	}
 
-	Team struct {
+	PortTeam struct {
 		CreatedAt   *time.Time `json:"createdAt,omitempty"`
 		UpdatedAt   *time.Time `json:"updatedAt,omitempty"`
 		Name        string     `json:"name,omitempty"`
@@ -420,6 +420,11 @@ type (
 		Provider    string     `json:"provider,omitempty"`
 	}
 
+	Team struct {
+		PortTeam
+		Identifier *string `json:"identifier,omitempty"`
+	}
+
 	Migration struct {
 		Meta
 		Id              string `json:"id,omitempty"`
@@ -490,11 +495,12 @@ type PortBody struct {
 	ActionPermissions    ActionPermissions `json:"permissions"`
 	Webhook              Webhook           `json:"integration"`
 	Scorecard            Scorecard         `json:"Scorecard"`
-	Team                 Team              `json:"team"`
+	Team                 PortTeam          `json:"team"`
 	Page                 Page              `json:"page"`
 	MigrationId          string            `json:"migrationId"`
 	Migration            Migration         `json:"migration"`
 	Folder               Folder            `json:"folder"`
+	Organization         *Organization     `json:"organization"`
 }
 
 type SearchEntityResult struct {
@@ -560,3 +566,8 @@ type Integration struct {
 	Config               *map[string]any       `json:"config"`
 	ChangelogDestination *ChangelogDestination `json:"changelogDestination,omitempty"`
 }
+
+type Organization struct {
+	Name         string   `json:"name"`
+	FeatureFlags []string `json:"featureFlags"`
+}

internal/cli/client.go

@@ -0,0 +1,26 @@
+package cli
+
+import (
+	"context"
+	"fmt"
+)
+
+const orgUrl = "/v1/organization"
+
+func (c *PortClient) ReadOrganization(ctx context.Context) (*Organization, int, error) {
+	pb := &PortBody{}
+	resp, err := c.Client.R().
+		SetContext(ctx).
+		SetHeader("Accept", "application/json").
+		SetResult(pb).
+		Get(orgUrl)
+	if err != nil {
+		return nil, 0, err
+	} else if resp.IsError() {
+		return nil, resp.StatusCode(), fmt.Errorf("failed to read organization, got: %s", resp.Body())
+	}
+	if pb.Organization == nil {
+		return nil, 0, fmt.Errorf("port-api returned an invalid response: Organization is nil")
+	}
+	return pb.Organization, resp.StatusCode(), nil
+}