Merge pull request #2262 from diggerhq/fix/attribution-otf

Add appropriate attributions in source

Author: ZIJ

taco/README.md

@@ -635,3 +635,23 @@ terraform init -reconfigure && terraform apply -auto-approve
 ```
 
 More details in `docs/s3-compat.md`.
+
+
+## Attribution
+
+Portions of the state management piece that relate to TFE API compatability and domain models have been adopted from the OTF project: https://github.com/leg100/otf,
+it has really helped support the cloud{} block support in opentaco statesman without alot of reverse engineering the TFE API, so we are grateful for this work. The following
+is a detailed list of these items:
+
+| File                              | Adapted Elements                                                                                                       |
+|-----------------------------------|------------------------------------------------------------------------------------------------------------------------|
+| internal/domain/tfe_id.go         | The `TFEID` struct and functions on it, including `MustHardcodeTfeID`, `ParseTfeID`, `NewTfeID`, and `NewTfeIDWithVal` |
+| internal/domain/tfe_kind.go       | All the constants that end in `Kind` within this file have been adapted as enums                                       |
+| internal/domain/tfe_org.go        | `DefaultOrganizationPermissions`, `TFEOrganizationPermissions`, `TFEOrganization`, and `TFEEntitleÒments` structs      |
+| internal/domain/tfe_workspace.go  | `Workspace`, `TFEWorkspace`, and all their embedded structs adapted to match the domain model                          |
+| internal/tfe/organizations.go     | `Entitlements`, `defaultEntitlements`, and `GetOranizationEntitlements` functions                                      |
+| internal/tfe/well_known.go        | Structs related to `DiscoverSpec` and the `GetWellKnownJson` function adapted for use with Opentaco                    |
+| internal/tfe_workspaces.go        | `ToTFE` and `GetWorkspace` adapted for use with current Opentaco endpoints                                             |
+
+
+

taco/internal/domain/tfe_id.go

@@ -9,11 +9,13 @@ import (
 
 const base58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type ID interface {
 	fmt.Stringer
 	Kind() Kind
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func GenerateRandomStringFromAlphabet(size int, alphabet string) string {
 	buf := make([]byte, size)
 	for i := 0; i < size; i++ {
@@ -28,6 +30,7 @@ func ConvertTfeID(id TfeID, to Kind) TfeID {
 	return TfeID{kind: to, id: id.id}
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func MustHardcodeTfeID(kind Kind, suffix string) TfeID {
 	s := fmt.Sprintf("%s-%s", kind, suffix)
 	id, err := ParseTfeID(s)
@@ -37,6 +40,7 @@ func MustHardcodeTfeID(kind Kind, suffix string) TfeID {
 	return id
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 // ParseTfeID parses the ID from a string representation.
 func ParseTfeID(s string) (TfeID, error) {
 	parts := strings.Split(s, "-")
@@ -54,6 +58,8 @@ func ParseTfeID(s string) (TfeID, error) {
 	return TfeID{kind: Kind(kind), id: id}, nil
 }
 
+// The following struct and all struct methods have been
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TfeID struct {
 	kind Kind
 	id   string
@@ -107,10 +113,12 @@ func (id *TfeID) Value() (driver.Value, error) {
 	return id.String(), nil
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func NewTfeID(kind Kind) TfeID {
 	return TfeID{kind: kind, id: GenerateRandomStringFromAlphabet(16, base58)}
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func NewTfeIDWithVal(kind Kind, id string) TfeID {
 	return TfeID{kind: kind, id: id}
 }

taco/internal/domain/tfe_kind.go

@@ -6,6 +6,7 @@ func (k Kind) String() string {
 	return string(k)
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 const (
 	SiteKind                      Kind = "site"
 	OrganizationKind              Kind = "org"

taco/internal/domain/tfe_org.go

@@ -2,12 +2,14 @@ package domain
 
 import "time"
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 var DefaultOrganizationPermissions = TFEOrganizationPermissions{
 	CanCreateWorkspace: true,
 	CanUpdate:          true,
 	CanDestroy:         true,
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEOrganizationPermissions struct {
 	CanCreateTeam               bool `json:"can-create-team"`
 	CanCreateWorkspace          bool `json:"can-create-workspace"`
@@ -30,6 +32,7 @@ func NewName(name string) Name {
 
 type TFEAuthPolicyType string
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEOrganization struct {
 	// Primary ID
 	Name string `jsonapi:"primary,organizations"`
@@ -58,6 +61,7 @@ type TFEOrganization struct {
 	// DefaultProject *Project `jsonapi:"relation,default-project"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEEntitlements struct {
 	ID                    string `jsonapi:"primary,entitlement-sets"`
 	Agents                bool   `jsonapi:"attr,agents" json:"agents"`

taco/internal/domain/tfe_workspace.go

@@ -16,6 +16,7 @@ type VCSRepo struct {
 	name  string
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type VCSConnection struct {
 	// Pushes to this VCS branch trigger runs. Empty string means the default
 	// branch is used. Ignored if TagsRegex is non-empty.
@@ -33,6 +34,7 @@ type VCSConnection struct {
 	AllowCLIApply bool
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type WorkspaceVersion struct {
 	// Latest if true means runs use the Latest available version at time of
 	// creation of the run.
@@ -44,6 +46,8 @@ type WorkspaceVersion struct {
 	semver string
 }
 
+// Following struct and its methods have been
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 // If you ever marshal this domain type via jsonapi (you currently don't),
 // its tags must also be valid. Fixing them anyway for completeness.
 type Workspace struct {
@@ -89,10 +93,12 @@ func (ws *Workspace) Locked() bool {
 
 // ---- JSON:API DTOs below ----
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEWorkspaceActions struct {
 	IsDestroyable bool `json:"is-destroyable"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEWorkspacePermissions struct {
 	CanDestroy        bool `json:"can-destroy"`
 	CanForceUnlock    bool `json:"can-force-unlock"`
@@ -106,6 +112,7 @@ type TFEWorkspacePermissions struct {
 	CanUpdateVariable bool `json:"can-update-variable"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 // TFEVCSRepo is carried as a single attribute object on the workspace.
 type TFEVCSRepo struct {
 	Branch            string  `json:"branch"`
@@ -118,10 +125,12 @@ type TFEVCSRepo struct {
 	ServiceProvider   string  `json:"service-provider"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFERun struct {
 	ID string `jsonapi:"primary,runs"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEWorkspace struct {
 	ID                         string                   `jsonapi:"primary,workspaces"`
 	Actions                    *TFEWorkspaceActions     `jsonapi:"attr,actions" json:"actions"`
@@ -165,6 +174,7 @@ type TFEWorkspace struct {
 	Outputs      []*TFEWorkspaceOutput `jsonapi:"relation,outputs" json:"outputs"`
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type TFEWorkspaceOutput struct {
 	ID        string `jsonapi:"primary,workspace-outputs"`
 	Name      string `jsonapi:"attr,Name" json:"Name"`

taco/internal/tfe/organizations.go

@@ -10,6 +10,7 @@ import (
 	"github.com/labstack/echo/v4"
 )
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 type Entitlements struct {
 	ID                    domain.TfeID
 	Agents                bool
@@ -24,6 +25,7 @@ type Entitlements struct {
 	VCSIntegrations       bool
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func defaultEntitlements(organizationID domain.TfeID) Entitlements {
 	return Entitlements{
 		ID:                    organizationID,
@@ -40,6 +42,7 @@ func defaultEntitlements(organizationID domain.TfeID) Entitlements {
 	}
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func (h *TfeHandler) GetOrganizationEntitlements(c echo.Context) error {
 	tfidStr := domain.NewTfeIDWithVal(domain.OrganizationKind, "RoiPNhWzpjaKhjcV")
 	domain.NewTfeID(domain.OrganizationKind)

taco/internal/tfe/well_known.go

@@ -21,6 +21,8 @@ const (
 	TokenRoute = "/tfe/oauth2/token"
 )
 
+// These Discovery structs have been
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 // login stuff, TODO: move to own package etc
 type DiscoverySpec struct {
 	Client     string   `json:"client"`

taco/internal/tfe/workspaces.go

@@ -221,6 +221,7 @@ func (h *TfeHandler) checkWorkspacePermission(c echo.Context, action string, wor
 	return nil
 }
 
+// Adapted from OTF (MPL License): https://github.com/leg100/otf
 func ToTFE(from *domain.Workspace) (*domain.TFEWorkspace, error) {
 	perms := &domain.TFEWorkspacePermissions{
 		CanLock:           true,