|
| 1 | +package catalog |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "fmt" |
| 7 | + "sort" |
| 8 | + "strings" |
| 9 | + "time" |
| 10 | + |
| 11 | + "github.com/databricks/databricks-sdk-go/apierr" |
| 12 | + "github.com/databricks/databricks-sdk-go/service/catalog" |
| 13 | + "github.com/databricks/terraform-provider-databricks/catalog/permissions" |
| 14 | + "github.com/databricks/terraform-provider-databricks/common" |
| 15 | + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" |
| 16 | +) |
| 17 | + |
| 18 | +// diffPermissionsForPrincipal returns an array of catalog.PermissionsChange of this permissions list with `diff` privileges removed |
| 19 | +func diffPermissionsForPrincipal(principal string, desired catalog.PermissionsList, existing catalog.PermissionsList) (diff []catalog.PermissionsChange) { |
| 20 | + // diffs change sets for principal |
| 21 | + configured := map[string]*schema.Set{} |
| 22 | + for _, v := range desired.PrivilegeAssignments { |
| 23 | + if v.Principal == principal { |
| 24 | + configured[v.Principal] = permissions.SliceToSet(v.Privileges) |
| 25 | + } |
| 26 | + } |
| 27 | + // existing permissions that needs removal for principal |
| 28 | + remote := map[string]*schema.Set{} |
| 29 | + for _, v := range existing.PrivilegeAssignments { |
| 30 | + if v.Principal == principal { |
| 31 | + remote[v.Principal] = permissions.SliceToSet(v.Privileges) |
| 32 | + } |
| 33 | + } |
| 34 | + // STEP 1: detect overlaps |
| 35 | + for principal, confPrivs := range configured { |
| 36 | + remotePrivs, ok := remote[principal] |
| 37 | + if !ok { |
| 38 | + remotePrivs = permissions.SliceToSet([]catalog.Privilege{}) |
| 39 | + } |
| 40 | + add := permissions.SetToSlice(confPrivs.Difference(remotePrivs)) |
| 41 | + remove := permissions.SetToSlice(remotePrivs.Difference(confPrivs)) |
| 42 | + if len(add) == 0 && len(remove) == 0 { |
| 43 | + continue |
| 44 | + } |
| 45 | + diff = append(diff, catalog.PermissionsChange{ |
| 46 | + Principal: principal, |
| 47 | + Add: add, |
| 48 | + Remove: remove, |
| 49 | + }) |
| 50 | + } |
| 51 | + // STEP 2: non overlap - simply remove |
| 52 | + for principal, remove := range remote { |
| 53 | + _, ok := configured[principal] |
| 54 | + if ok { // already handled in STEP 1 |
| 55 | + continue |
| 56 | + } |
| 57 | + diff = append(diff, catalog.PermissionsChange{ |
| 58 | + Principal: principal, |
| 59 | + Remove: permissions.SetToSlice(remove), |
| 60 | + }) |
| 61 | + } |
| 62 | + // so that we can deterministic tests |
| 63 | + sort.Slice(diff, func(i, j int) bool { |
| 64 | + return diff[i].Principal < diff[j].Principal |
| 65 | + }) |
| 66 | + return diff |
| 67 | +} |
| 68 | + |
| 69 | +// replacePermissionsForPrincipal merges removal diff of existing permissions on the platform |
| 70 | +func replacePermissionsForPrincipal(a permissions.UnityCatalogPermissionsAPI, securable string, name string, principal string, list catalog.PermissionsList) error { |
| 71 | + securableType := permissions.Mappings.GetSecurableType(securable) |
| 72 | + existing, err := a.GetPermissions(securableType, name) |
| 73 | + if err != nil { |
| 74 | + return err |
| 75 | + } |
| 76 | + err = a.UpdatePermissions(securableType, name, diffPermissionsForPrincipal(principal, list, *existing)) |
| 77 | + if err != nil { |
| 78 | + return err |
| 79 | + } |
| 80 | + return a.WaitForUpdate(1*time.Minute, securableType, name, list, func(current *catalog.PermissionsList, desired catalog.PermissionsList) []catalog.PermissionsChange { |
| 81 | + return diffPermissionsForPrincipal(principal, desired, *current) |
| 82 | + }) |
| 83 | +} |
| 84 | + |
| 85 | +// filterPermissionsForPrincipal extracts permissions for the given principal and transforms to permissions.UnityCatalogPrivilegeAssignment to match Schema |
| 86 | +func filterPermissionsForPrincipal(in catalog.PermissionsList, principal string) (*permissions.UnityCatalogPrivilegeAssignment, error) { |
| 87 | + grantsForPrincipal := []permissions.UnityCatalogPrivilegeAssignment{} |
| 88 | + for _, v := range in.PrivilegeAssignments { |
| 89 | + privileges := []string{} |
| 90 | + if v.Principal == principal { |
| 91 | + for _, p := range v.Privileges { |
| 92 | + privileges = append(privileges, p.String()) |
| 93 | + } |
| 94 | + grantsForPrincipal = append(grantsForPrincipal, permissions.UnityCatalogPrivilegeAssignment{ |
| 95 | + Principal: v.Principal, |
| 96 | + Privileges: privileges, |
| 97 | + }) |
| 98 | + } |
| 99 | + } |
| 100 | + if len(grantsForPrincipal) == 0 { |
| 101 | + return nil, apierr.NotFound("got empty permissions list") |
| 102 | + } |
| 103 | + if len(grantsForPrincipal) > 1 { |
| 104 | + return nil, errors.New("got more than one principal in permissions list") |
| 105 | + } |
| 106 | + return &grantsForPrincipal[0], nil |
| 107 | +} |
| 108 | + |
| 109 | +func toSecurableId(d *schema.ResourceData) string { |
| 110 | + principal := d.Get("principal").(string) |
| 111 | + return fmt.Sprintf("%s/%s", permissions.Mappings.Id(d), principal) |
| 112 | +} |
| 113 | + |
| 114 | +func parseSecurableId(d *schema.ResourceData) (string, string, string, error) { |
| 115 | + split := strings.SplitN(d.Id(), "/", 3) |
| 116 | + if len(split) != 3 { |
| 117 | + return "", "", "", fmt.Errorf("ID must be three elements split by `/`: %s", d.Id()) |
| 118 | + } |
| 119 | + return split[0], split[1], split[2], nil |
| 120 | +} |
| 121 | + |
| 122 | +func ResourceGrant() *schema.Resource { |
| 123 | + s := common.StructToSchema(permissions.UnityCatalogPrivilegeAssignment{}, |
| 124 | + func(m map[string]*schema.Schema) map[string]*schema.Schema { |
| 125 | + |
| 126 | + m["principal"].ForceNew = true |
| 127 | + |
| 128 | + allFields := []string{} |
| 129 | + for field := range permissions.Mappings { |
| 130 | + allFields = append(allFields, field) |
| 131 | + } |
| 132 | + for field := range permissions.Mappings { |
| 133 | + m[field] = &schema.Schema{ |
| 134 | + Type: schema.TypeString, |
| 135 | + Optional: true, |
| 136 | + ForceNew: true, |
| 137 | + AtLeastOneOf: allFields, |
| 138 | + ConflictsWith: permissions.SliceWithoutString(allFields, field), |
| 139 | + } |
| 140 | + } |
| 141 | + return m |
| 142 | + }) |
| 143 | + |
| 144 | + return common.Resource{ |
| 145 | + Schema: s, |
| 146 | + Create: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error { |
| 147 | + principal := d.Get("principal").(string) |
| 148 | + privileges := permissions.SetToSlice(d.Get("privileges").(*schema.Set)) |
| 149 | + var grants = catalog.PermissionsList{ |
| 150 | + PrivilegeAssignments: []catalog.PrivilegeAssignment{ |
| 151 | + { |
| 152 | + Principal: principal, |
| 153 | + Privileges: privileges, |
| 154 | + }, |
| 155 | + }, |
| 156 | + } |
| 157 | + securable, name := permissions.Mappings.KeyValue(d) |
| 158 | + unityCatalogPermissionsAPI := permissions.NewUnityCatalogPermissionsAPI(ctx, c) |
| 159 | + err := replacePermissionsForPrincipal(unityCatalogPermissionsAPI, securable, name, principal, grants) |
| 160 | + if err != nil { |
| 161 | + return err |
| 162 | + } |
| 163 | + d.SetId(toSecurableId(d)) |
| 164 | + return nil |
| 165 | + }, |
| 166 | + Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error { |
| 167 | + securable, name, principal, err := parseSecurableId(d) |
| 168 | + if err != nil { |
| 169 | + return err |
| 170 | + } |
| 171 | + grants, err := permissions.NewUnityCatalogPermissionsAPI(ctx, c).GetPermissions(permissions.Mappings.GetSecurableType(securable), name) |
| 172 | + if err != nil { |
| 173 | + return err |
| 174 | + } |
| 175 | + grantsForPrincipal, err := filterPermissionsForPrincipal(*grants, principal) |
| 176 | + if err != nil { |
| 177 | + return err |
| 178 | + } |
| 179 | + return common.StructToData(*grantsForPrincipal, s, d) |
| 180 | + }, |
| 181 | + Update: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error { |
| 182 | + securable, name, principal, err := parseSecurableId(d) |
| 183 | + if err != nil { |
| 184 | + return err |
| 185 | + } |
| 186 | + privileges := permissions.SetToSlice(d.Get("privileges").(*schema.Set)) |
| 187 | + var grants = catalog.PermissionsList{ |
| 188 | + PrivilegeAssignments: []catalog.PrivilegeAssignment{ |
| 189 | + { |
| 190 | + Principal: principal, |
| 191 | + Privileges: privileges, |
| 192 | + }, |
| 193 | + }, |
| 194 | + } |
| 195 | + unityCatalogPermissionsAPI := permissions.NewUnityCatalogPermissionsAPI(ctx, c) |
| 196 | + return replacePermissionsForPrincipal(unityCatalogPermissionsAPI, securable, name, principal, grants) |
| 197 | + }, |
| 198 | + Delete: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error { |
| 199 | + securable, name, principal, err := parseSecurableId(d) |
| 200 | + if err != nil { |
| 201 | + return err |
| 202 | + } |
| 203 | + unityCatalogPermissionsAPI := permissions.NewUnityCatalogPermissionsAPI(ctx, c) |
| 204 | + return replacePermissionsForPrincipal(unityCatalogPermissionsAPI, securable, name, principal, catalog.PermissionsList{}) |
| 205 | + }, |
| 206 | + }.ToResource() |
| 207 | +} |
0 commit comments