Merge pull request #304 from OpsLevel/db/revert-entity-owner-struct-r…

…emoval Db/revert entity owner struct removal
OpsLevel · Nov 14, 2023 · b81d606 · b81d606
2 parents 72633dd + e70ad3a
commit b81d606
Show file tree

Hide file tree

Showing 15 changed files with 107 additions and 52 deletions.
diff --git a/.changes/unreleased/Bugfix-20231114-142739.yaml b/.changes/unreleased/Bugfix-20231114-142739.yaml
@@ -0,0 +1,3 @@
+kind: Bugfix
+body: revert removal of EntityOwner struct, not yet removed in API
+time: 2023-11-14T14:27:39.915374-06:00
diff --git a/domain.go b/domain.go
@@ -9,11 +9,11 @@ type DomainId Identifier
 
 type Domain struct {
 	DomainId
-	Name        string `graphql:"name"`
-	Description string `graphql:"description"`
-	HTMLUrl     string `graphql:"htmlUrl"`
-	Owner       TeamId `graphql:"owner"`
-	Note        string `graphql:"note"`
+	Name        string      `graphql:"name"`
+	Description string      `graphql:"description"`
+	HTMLUrl     string      `graphql:"htmlUrl"`
+	Owner       EntityOwner `graphql:"owner"`
+	Note        string      `graphql:"note"`
 }
 
 type DomainConnection struct {

diff --git a/domain_test.go b/domain_test.go
@@ -18,7 +18,7 @@ func TestDomainCreate(t *testing.T) {
 		})
 
 	testRequest := NewTestRequest(
-		`"mutation DomainCreate($input:DomainInput!){domainCreate(input:$input){domain{id,aliases,name,description,htmlUrl,owner{alias,id},note},errors{message,path}}}"`,
+		`"mutation DomainCreate($input:DomainInput!){domainCreate(input:$input){domain{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},errors{message,path}}}"`,
 		`{"input": {{ template "domain_create_input" }} }`,
 		`{"data": {"domainCreate": {"domain": {{ template "domain1_response" }} }}}`,
 	)
@@ -35,12 +35,12 @@ func TestDomainCreate(t *testing.T) {
 func TestDomainGetSystems(t *testing.T) {
 	// Arrange
 	testRequestOne := NewTestRequest(
-		`"query DomainChildSystemsList($after:String!$domain:IdentifierInput!$first:Int!){account{domain(input: $domain){childSystems(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{alias,id},parent{id,aliases,name,description,htmlUrl,owner{alias,id},note},note},{{ template "pagination_request" }}}}}}"`,
+		`"query DomainChildSystemsList($after:String!$domain:IdentifierInput!$first:Int!){account{domain(input: $domain){childSystems(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},parent{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},note},{{ template "pagination_request" }}}}}}"`,
 		`{ {{ template "first_page_variables" }}, "domain": { {{ template "id2" }} } }`,
 		`{ "data": { "account": { "domain": { "childSystems": { "nodes": [ {{ template "system1_response" }}, {{ template "system2_response" }} ], {{ template "pagination_initial_pageInfo_response" }} }}}}}`,
 	)
 	testRequestTwo := NewTestRequest(
-		`"query DomainChildSystemsList($after:String!$domain:IdentifierInput!$first:Int!){account{domain(input: $domain){childSystems(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{alias,id},parent{id,aliases,name,description,htmlUrl,owner{alias,id},note},note},{{ template "pagination_request" }}}}}}"`,
+		`"query DomainChildSystemsList($after:String!$domain:IdentifierInput!$first:Int!){account{domain(input: $domain){childSystems(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},parent{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},note},{{ template "pagination_request" }}}}}}"`,
 		`{ {{ template "second_page_variables" }}, "domain": { {{ template "id2" }} } }`,
 		`{ "data": { "account": { "domain": { "childSystems": { "nodes": [ {{ template "system3_response" }} ], {{ template "pagination_second_pageInfo_response" }} }}}}}`,
 	)
@@ -96,7 +96,7 @@ func TestDomainGetTags(t *testing.T) {
 func TestDomainAssignSystem(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"mutation DomainAssignSystem($childSystems:[IdentifierInput!]!$domain:IdentifierInput!){domainChildAssign(domain:$domain, childSystems:$childSystems){domain{id,aliases,name,description,htmlUrl,owner{alias,id},note},errors{message,path}}}"`,
+		`"mutation DomainAssignSystem($childSystems:[IdentifierInput!]!$domain:IdentifierInput!){domainChildAssign(domain:$domain, childSystems:$childSystems){domain{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},errors{message,path}}}"`,
 		`{"domain":{ {{ template "id1" }} }, "childSystems": [ { {{ template "id3" }} } ] }`,
 		`{"data": {"domainChildAssign": {"domain": {{ template "domain1_response" }} }}}`,
 	)
@@ -116,7 +116,7 @@ func TestDomainAssignSystem(t *testing.T) {
 func TestDomainGetId(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"query DomainGet($input:IdentifierInput!){account{domain(input: $input){id,aliases,name,description,htmlUrl,owner{alias,id},note}}}"`,
+		`"query DomainGet($input:IdentifierInput!){account{domain(input: $input){id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note}}}"`,
 		`{"input": { {{ template "id1" }} }}`,
 		`{"data": {"account": {"domain": {{ template "domain1_response" }} }}}`,
 	)
@@ -132,7 +132,7 @@ func TestDomainGetId(t *testing.T) {
 func TestDomainGetAlias(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"query DomainGet($input:IdentifierInput!){account{domain(input: $input){id,aliases,name,description,htmlUrl,owner{alias,id},note}}}"`,
+		`"query DomainGet($input:IdentifierInput!){account{domain(input: $input){id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note}}}"`,
 		`{"input": {"alias": "my-domain" }}`,
 		`{"data": {"account": {"domain": {{ template "domain1_response" }} }}}`,
 	)
@@ -148,12 +148,12 @@ func TestDomainGetAlias(t *testing.T) {
 func TestDomainList(t *testing.T) {
 	// Arrange
 	testRequestOne := NewTestRequest(
-		`"query DomainsList($after:String!$first:Int!){account{domains(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{alias,id},note},{{ template "pagination_request" }}}}}"`,
+		`"query DomainsList($after:String!$first:Int!){account{domains(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},{{ template "pagination_request" }}}}}"`,
 		`{{ template "pagination_initial_query_variables" }}`,
 		`{ "data": { "account": { "domains": { "nodes": [ {{ template "domain1_response" }}, {{ template "domain2_response" }} ], {{ template "pagination_initial_pageInfo_response" }} }}}}`,
 	)
 	testRequestTwo := NewTestRequest(
-		`"query DomainsList($after:String!$first:Int!){account{domains(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{alias,id},note},{{ template "pagination_request" }}}}}"`,
+		`"query DomainsList($after:String!$first:Int!){account{domains(after: $after, first: $first){nodes{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},{{ template "pagination_request" }}}}}"`,
 		`{{ template "pagination_second_query_variables" }}`,
 		`{ "data": { "account": { "domains": { "nodes": [ {{ template "domain3_response" }} ], {{ template "pagination_second_pageInfo_response" }} }}}}`,
 	)
@@ -182,7 +182,7 @@ func TestDomainUpdate(t *testing.T) {
 		})
 
 	testRequest := NewTestRequest(
-		`"mutation DomainUpdate($domain:IdentifierInput!$input:DomainInput!){domainUpdate(domain:$domain,input:$input){domain{id,aliases,name,description,htmlUrl,owner{alias,id},note},errors{message,path}}}"`,
+		`"mutation DomainUpdate($domain:IdentifierInput!$input:DomainInput!){domainUpdate(domain:$domain,input:$input){domain{id,aliases,name,description,htmlUrl,owner{... on Team{teamAlias:alias,id}},note},errors{message,path}}}"`,
 		`{"domain": { {{ template "id1" }} }, "input": {{ template "domain_update_input" }} }`,
 		`{"data": {"domainUpdate": {"domain": {{ template "domain1_response" }} }}}`,
 	)

diff --git a/infra.go b/infra.go
@@ -29,7 +29,7 @@ type InfrastructureResource struct {
 	Schema       string                             `json:"type" graphql:"type @include(if: $all)"`
 	ProviderType string                             `json:"providerResourceType" graphql:"providerResourceType @include(if: $all)"`
 	ProviderData InfrastructureResourceProviderData `json:"providerData" graphql:"providerData @include(if: $all)"`
-	Owner        TeamId                             `json:"owner" graphql:"owner @include(if: $all)"`
+	Owner        EntityOwner                        `json:"owner" graphql:"owner @include(if: $all)"`
 	OwnerLocked  bool                               `json:"ownerLocked" graphql:"ownerLocked @include(if: $all)"`
 	ParsedData   JSON                               `json:"data" scalar:"true" graphql:"data @include(if: $all)"`
 	Data         JSON                               `json:"rawData" scalar:"true" graphql:"rawData @include(if: $all)"`

diff --git a/infra_test.go b/infra_test.go
@@ -10,7 +10,7 @@ import (
 func TestCreateInfra(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"mutation InfrastructureResourceCreate($all:Boolean!$input:InfrastructureResourceInput!){infrastructureResourceCreate(input: $input){infrastructureResource{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){alias,id},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},warnings{message},errors{message,path}}}"`,
+		`"mutation InfrastructureResourceCreate($all:Boolean!$input:InfrastructureResourceInput!){infrastructureResourceCreate(input: $input){infrastructureResource{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},warnings{message},errors{message,path}}}"`,
 		`{
     "all": true,
     "input": {
@@ -59,7 +59,7 @@ func TestCreateInfra(t *testing.T) {
 func TestGetInfra(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"query InfrastructureResourceGet($all:Boolean!$input:IdentifierInput!){account{infrastructureResource(input: $input){id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){alias,id},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)}}}"`,
+		`"query InfrastructureResourceGet($all:Boolean!$input:IdentifierInput!){account{infrastructureResource(input: $input){id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)}}}"`,
 		`{"all": true, "input":{ {{ template "id1" }} }}`,
 		`{"data": { "account": { "infrastructureResource": {{ template "infra_1" }} }}}`,
 	)
@@ -101,12 +101,12 @@ func TestListInfraSchemas(t *testing.T) {
 func TestListInfra(t *testing.T) {
 	// Arrange
 	testRequestOne := NewTestRequest(
-		`"query IntegrationList($after:String!$all:Boolean!$first:Int!){account{infrastructureResources(after: $after, first: $first){nodes{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){alias,id},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},{{ template "pagination_request" }}}}}"`,
+		`"query IntegrationList($after:String!$all:Boolean!$first:Int!){account{infrastructureResources(after: $after, first: $first){nodes{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},{{ template "pagination_request" }}}}}"`,
 		`{ "after": "", "all": true, "first": 100 }`,
 		`{ "data": { "account": { "infrastructureResources": { "nodes": [ {{ template "infra_1" }}, {{ template "infra_2" }} ], {{ template "pagination_initial_pageInfo_response" }} }}}}`,
 	)
 	testRequestTwo := NewTestRequest(
-		`"query IntegrationList($after:String!$all:Boolean!$first:Int!){account{infrastructureResources(after: $after, first: $first){nodes{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){alias,id},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},{{ template "pagination_request" }}}}}"`,
+		`"query IntegrationList($after:String!$all:Boolean!$first:Int!){account{infrastructureResources(after: $after, first: $first){nodes{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},{{ template "pagination_request" }}}}}"`,
 		`{ "after": "OA", "all": true, "first": 100 }`,
 		`{ "data": { "account": { "infrastructureResources": { "nodes": [ {{ template "infra_3" }} ], {{ template "pagination_second_pageInfo_response" }} }}}}`,
 	)
@@ -126,7 +126,7 @@ func TestListInfra(t *testing.T) {
 func TestUpdateInfra(t *testing.T) {
 	// Arrange
 	testRequest := NewTestRequest(
-		`"mutation InfrastructureResourceUpdate($all:Boolean!$identifier:IdentifierInput!$input:InfrastructureResourceInput!){infrastructureResourceUpdate(infrastructureResource: $identifier, input: $input){infrastructureResource{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){alias,id},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},warnings{message},errors{message,path}}}"`,
+		`"mutation InfrastructureResourceUpdate($all:Boolean!$identifier:IdentifierInput!$input:InfrastructureResourceInput!){infrastructureResourceUpdate(infrastructureResource: $identifier, input: $input){infrastructureResource{id,aliases,name,type @include(if: $all),providerResourceType @include(if: $all),providerData @include(if: $all){accountName,externalUrl,providerName},owner @include(if: $all){... on Team{teamAlias:alias,id}},ownerLocked @include(if: $all),data @include(if: $all),rawData @include(if: $all)},warnings{message},errors{message,path}}}"`,
 		`{"all": true, "identifier": { {{ template "id1" }}}, "input": { "ownerId": "{{ template "id1_string" }}", "data": "{\"endpoint\":\"https://google.com\",\"engine\":\"BigQuery\",\"name\":\"my-big-query\",\"replica\":false}" }}`,
 		`{"data": { "infrastructureResourceUpdate": { "infrastructureResource": {{ template "infra_1" }}, "warnings": [], "errors": [] }}}`,
 	)

diff --git a/owner.go b/owner.go
@@ -0,0 +1,25 @@
+package opslevel
+
+type EntityOwnerTeam struct {
+	Alias string `json:"alias,omitempty" graphql:"teamAlias:alias"`
+	Id    ID     `json:"id"`
+}
+
+type EntityOwner struct {
+	OnTeam EntityOwnerTeam `graphql:"... on Team"`
+}
+
+func (s *EntityOwner) Alias() string {
+	return s.OnTeam.Alias
+}
+
+func (s *EntityOwner) Id() ID {
+	return s.OnTeam.Id
+}
+
+func (s *EntityOwnerTeam) AsTeam() TeamId {
+	return TeamId{
+		Alias: s.Alias,
+		Id:    s.Id,
+	}
+}
diff --git a/owner_test.go b/owner_test.go
@@ -0,0 +1,24 @@
+package opslevel_test
+
+import (
+	"testing"
+
+	ol "github.com/opslevel/opslevel-go/v2023"
+	"github.com/rocktavious/autopilot/v2023"
+)
+
+func TestEntityOwnerTeamReturnsCorrectId(t *testing.T) {
+	// Arrange
+	owner := ol.EntityOwner{
+		OnTeam: ol.EntityOwnerTeam{
+			Id:    id1,
+			Alias: "Example",
+		},
+	}
+	// Act
+	// Assert
+	autopilot.Equals(t, id1, owner.Id())
+	autopilot.Equals(t, id1, owner.OnTeam.AsTeam().Id)
+	autopilot.Equals(t, "Example", owner.Alias())
+	autopilot.Equals(t, "Example", owner.OnTeam.AsTeam().Alias)
+}
diff --git a/scorecards.go b/scorecards.go
@@ -12,14 +12,14 @@ type ScorecardId struct {
 type Scorecard struct {
 	ScorecardId
 
-	AffectsOverallServiceLevels bool   `graphql:"affectsOverallServiceLevels"`
-	Description                 string `graphql:"description"` // optional
-	Filter                      Filter `graphql:"filter"`      // optional
-	Name                        string `graphql:"name"`
-	Owner                       TeamId `graphql:"owner"`
-	PassingChecks               int    `graphql:"passingChecks"`
-	ServiceCount                int    `graphql:"serviceCount"`
-	ChecksCount                 int    `graphql:"totalChecks"`
+	AffectsOverallServiceLevels bool        `graphql:"affectsOverallServiceLevels"`
+	Description                 string      `graphql:"description"` // optional
+	Filter                      Filter      `graphql:"filter"`      // optional
+	Name                        string      `graphql:"name"`
+	Owner                       EntityOwner `graphql:"owner"`
+	PassingChecks               int         `graphql:"passingChecks"`
+	ServiceCount                int         `graphql:"serviceCount"`
+	ChecksCount                 int         `graphql:"totalChecks"`
 }
 
 type ScorecardConnection struct {

diff --git a/scorecards_test.go b/scorecards_test.go
@@ -36,7 +36,7 @@ func TestCreateScorecard(t *testing.T) {
 	autopilot.Ok(t, err)
 	autopilot.Equals(t, name, sc.Name)
 	autopilot.Equals(t, description, sc.Description)
-	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id)
+	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id())
 	autopilot.Equals(t, *fakeFilterId, sc.Filter.Id)
 	autopilot.Equals(t, true, sc.AffectsOverallServiceLevels)
 }
@@ -62,7 +62,7 @@ func TestCreateScorecardDoesNotAffectServiceLevels(t *testing.T) {
 	autopilot.Ok(t, err)
 	autopilot.Equals(t, name, sc.Name)
 	autopilot.Equals(t, description, sc.Description)
-	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id)
+	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id())
 	autopilot.Equals(t, *fakeFilterId, sc.Filter.Id)
 	autopilot.Equals(t, false, sc.AffectsOverallServiceLevels)
 }
@@ -89,7 +89,7 @@ func TestUpdateScorecard(t *testing.T) {
 	autopilot.Equals(t, *ol.NewID(scorecardId), sc.Id)
 	autopilot.Equals(t, name, sc.Name)
 	autopilot.Equals(t, description, sc.Description)
-	autopilot.Equals(t, *newOwnerId, sc.Owner.Id)
+	autopilot.Equals(t, *newOwnerId, sc.Owner.Id())
 	autopilot.Equals(t, *newFilterId, sc.Filter.Id)
 	autopilot.Equals(t, false, sc.AffectsOverallServiceLevels)
 }
@@ -123,7 +123,7 @@ func TestGetScorecard(t *testing.T) {
 	autopilot.Equals(t, *ol.NewID(scorecardId), sc.Id)
 	autopilot.Equals(t, name, sc.Name)
 	autopilot.Equals(t, description, sc.Description)
-	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id)
+	autopilot.Equals(t, *fakeOwnerId, sc.Owner.Id())
 	autopilot.Equals(t, *fakeFilterId, sc.Filter.Id)
 	autopilot.Equals(t, 10, sc.PassingChecks)
 	autopilot.Equals(t, 20, sc.ServiceCount)
@@ -153,14 +153,14 @@ func TestListScorecards(t *testing.T) {
 	autopilot.Equals(t, 3, response.TotalCount)
 	autopilot.Equals(t, "first scorecard", result[0].Name)
 	autopilot.Equals(t, ol.ConnectiveEnumAnd, result[0].Filter.Connective)
-	autopilot.Equals(t, *fakeOwnerId, result[0].Owner.Id)
+	autopilot.Equals(t, *fakeOwnerId, result[0].Owner.Id())
 	autopilot.Equals(t, 150, result[0].ServiceCount)
 	autopilot.Equals(t, "second scorecard", result[1].Name)
 	autopilot.Equals(t, ol.ConnectiveEnumOr, result[1].Filter.Connective)
-	autopilot.Equals(t, *fakeOwnerId, result[0].Owner.Id)
+	autopilot.Equals(t, *fakeOwnerId, result[0].Owner.Id())
 	autopilot.Equals(t, 22, result[1].ServiceCount)
 	autopilot.Equals(t, "third scorecard", result[2].Name)
 	autopilot.Equals(t, ol.Filter{}, result[2].Filter)
-	autopilot.Equals(t, *newOwnerId, result[2].Owner.Id)
+	autopilot.Equals(t, *newOwnerId, result[2].Owner.Id())
 	autopilot.Equals(t, 33, result[2].ServiceCount)
 }
diff --git a/system.go b/system.go
@@ -9,12 +9,12 @@ type SystemId Identifier
 
 type System struct {
 	SystemId
-	Name        string `graphql:"name"`
-	Description string `graphql:"description"`
-	HTMLUrl     string `graphql:"htmlUrl"`
-	Owner       TeamId `graphql:"owner"`
-	Parent      Domain `graphql:"parent"`
-	Note        string `graphql:"note"`
+	Name        string      `graphql:"name"`
+	Description string      `graphql:"description"`
+	HTMLUrl     string      `graphql:"htmlUrl"`
+	Owner       EntityOwner `graphql:"owner"`
+	Parent      Domain      `graphql:"parent"`
+	Note        string      `graphql:"note"`
 }
 
 type SystemConnection struct {