Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[codegen/python] Fix incorrect ObjectType name generated under tfbridge20 compat #10935

Merged
merged 5 commits into from Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,4 @@
changes:
- type: fix
scope: sdkgen/python
description: Fixes dangling type-refs generated under compatibility=tfbridge20 for schemas that refer to types aross modules.
41 changes: 37 additions & 4 deletions pkg/codegen/python/gen.go
Expand Up @@ -89,8 +89,16 @@ func title(s string) string {
return string(append([]rune{unicode.ToUpper(runes[0])}, runes[1:]...))
}

type modLocator struct {
// Returns defining modlue for a given ObjectType. Returns nil
// for types that are not being generated in the current
// GeneratePacakge call.
objectTypeMod func(*schema.ObjectType) *modContext
}

type modContext struct {
pkg *schema.Package
modLocator *modLocator
mod string
pyPkgName string
types []*schema.ObjectType
Expand Down Expand Up @@ -131,13 +139,21 @@ func (mod *modContext) addChild(child *modContext) {
}

func (mod *modContext) details(t *schema.ObjectType) *typeDetails {
details, ok := mod.typeDetails[t]
m := mod

if mod.modLocator != nil {
if actualMod := mod.modLocator.objectTypeMod(t); actualMod != nil {
m = actualMod
}
}

details, ok := m.typeDetails[t]
if !ok {
details = &typeDetails{}
if mod.typeDetails == nil {
mod.typeDetails = map[*schema.ObjectType]*typeDetails{}
if m.typeDetails == nil {
m.typeDetails = map[*schema.ObjectType]*typeDetails{}
}
mod.typeDetails[t] = details
m.typeDetails[t] = details
}
return details
}
Expand Down Expand Up @@ -2616,6 +2632,7 @@ func generateModuleContextMap(tool string, pkg *schema.Package, info PackageInfo
}

// group resources, types, and functions into modules
// modules map will contain modContext entries for all modules in current package (pkg)
modules := map[string]*modContext{}

var getMod func(modName string, p *schema.Package) *modContext
Expand Down Expand Up @@ -2766,6 +2783,22 @@ func generateModuleContextMap(tool string, pkg *schema.Package, info PackageInfo
mod.extraSourceFiles = append(mod.extraSourceFiles, p)
}

// Setup modLocator so that mod.typeDetails finds the right
// modContext for every ObjectType.
modLocator := &modLocator{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why we need the extra struct here instead of just passing a handle to the func

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking in case it needs more methods later like EnumType, and I also like to have my obj.method() syntax to have an idea what the call is doing, but yeah technically could just have been func.

objectTypeMod: func(t *schema.ObjectType) *modContext {
if t.Package != pkg {
return nil
}

return getModFromToken(t.Token, t.Package)
},
}

for _, mod := range modules {
mod.modLocator = modLocator
}

return modules, nil
}

Expand Down
5 changes: 5 additions & 0 deletions pkg/codegen/testing/test/sdk_driver.go
Expand Up @@ -304,6 +304,11 @@ var PulumiPulumiSDKTests = []*SDKTest{
Description: "Generate a resource with secret properties",
SkipCompileCheck: codegen.NewStringSet(dotnet),
},
{
Directory: "regress-py-tfbridge-611",
Description: "Regresses pulumi/pulumi-terraform-bridge#611",
Skip: allLanguages.Except("python/any").Union(codegen.NewStringSet("python/test", "python/py_compile")),
},
}

var genSDKOnly bool
Expand Down
@@ -0,0 +1,16 @@
{
"emittedFiles": [
"pulumi_aws/README.md",
"pulumi_aws/__init__.py",
"pulumi_aws/_utilities.py",
"pulumi_aws/provider.py",
"pulumi_aws/pulumi-plugin.json",
"pulumi_aws/py.typed",
"pulumi_aws/x/__init__.py",
"pulumi_aws/x/_inputs.py",
"pulumi_aws/x/iam/__init__.py",
"pulumi_aws/x/iam/get_policy_document.py",
"pulumi_aws/x/outputs.py",
"setup.py"
]
}
@@ -0,0 +1,31 @@
# coding=utf-8
# *** WARNING: this file was generated by test. ***
# *** Do not edit by hand unless you're certain you know what you are doing! ***

from . import _utilities
import typing
# Export this package's modules as members:
from .provider import *

# Make subpackages available:
if typing.TYPE_CHECKING:
import pulumi_aws.x as __x
x = __x
else:
x = _utilities.lazy_import('pulumi_aws.x')

_utilities.register(
resource_modules="""
[]
""",
resource_packages="""
[
{
"pkg": "aws",
"token": "pulumi:providers:aws",
"fqn": "pulumi_aws",
"class": "Provider"
}
]
"""
)
@@ -0,0 +1,250 @@
# coding=utf-8
# *** WARNING: this file was generated by test. ***
# *** Do not edit by hand unless you're certain you know what you are doing! ***


import importlib.util
import inspect
import json
import os
import pkg_resources
import sys
import typing

import pulumi
import pulumi.runtime

from semver import VersionInfo as SemverVersion
from parver import Version as PEP440Version


def get_env(*args):
for v in args:
value = os.getenv(v)
if value is not None:
return value
return None


def get_env_bool(*args):
str = get_env(*args)
if str is not None:
# NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what
# Terraform uses internally when parsing boolean values.
if str in ["1", "t", "T", "true", "TRUE", "True"]:
return True
if str in ["0", "f", "F", "false", "FALSE", "False"]:
return False
return None


def get_env_int(*args):
str = get_env(*args)
if str is not None:
try:
return int(str)
except:
return None
return None


def get_env_float(*args):
str = get_env(*args)
if str is not None:
try:
return float(str)
except:
return None
return None


def _get_semver_version():
# __name__ is set to the fully-qualified name of the current module, In our case, it will be
# <some module>._utilities. <some module> is the module we want to query the version for.
root_package, *rest = __name__.split('.')

# pkg_resources uses setuptools to inspect the set of installed packages. We use it here to ask
# for the currently installed version of the root package (i.e. us) and get its version.

# Unfortunately, PEP440 and semver differ slightly in incompatible ways. The Pulumi engine expects
# to receive a valid semver string when receiving requests from the language host, so it's our
# responsibility as the library to convert our own PEP440 version into a valid semver string.

pep440_version_string = pkg_resources.require(root_package)[0].version
pep440_version = PEP440Version.parse(pep440_version_string)
(major, minor, patch) = pep440_version.release
prerelease = None
if pep440_version.pre_tag == 'a':
prerelease = f"alpha.{pep440_version.pre}"
elif pep440_version.pre_tag == 'b':
prerelease = f"beta.{pep440_version.pre}"
elif pep440_version.pre_tag == 'rc':
prerelease = f"rc.{pep440_version.pre}"
elif pep440_version.dev is not None:
prerelease = f"dev.{pep440_version.dev}"

# The only significant difference between PEP440 and semver as it pertains to us is that PEP440 has explicit support
# for dev builds, while semver encodes them as "prerelease" versions. In order to bridge between the two, we convert
# our dev build version into a prerelease tag. This matches what all of our other packages do when constructing
# their own semver string.
return SemverVersion(major=major, minor=minor, patch=patch, prerelease=prerelease)


# Determine the version once and cache the value, which measurably improves program performance.
_version = _get_semver_version()
_version_str = str(_version)


def get_version():
return _version_str

def get_resource_opts_defaults() -> pulumi.ResourceOptions:
return pulumi.ResourceOptions(
version=get_version(),
plugin_download_url=get_plugin_download_url(),
)

def get_invoke_opts_defaults() -> pulumi.InvokeOptions:
return pulumi.InvokeOptions(
version=get_version(),
plugin_download_url=get_plugin_download_url(),
)

def get_resource_args_opts(resource_args_type, resource_options_type, *args, **kwargs):
"""
Return the resource args and options given the *args and **kwargs of a resource's
__init__ method.
"""

resource_args, opts = None, None

# If the first item is the resource args type, save it and remove it from the args list.
if args and isinstance(args[0], resource_args_type):
resource_args, args = args[0], args[1:]

# Now look at the first item in the args list again.
# If the first item is the resource options class, save it.
if args and isinstance(args[0], resource_options_type):
opts = args[0]

# If resource_args is None, see if "args" is in kwargs, and, if so, if it's typed as the
# the resource args type.
if resource_args is None:
a = kwargs.get("args")
if isinstance(a, resource_args_type):
resource_args = a

# If opts is None, look it up in kwargs.
if opts is None:
opts = kwargs.get("opts")

return resource_args, opts


# Temporary: just use pulumi._utils.lazy_import once everyone upgrades.
def lazy_import(fullname):

import pulumi._utils as u
f = getattr(u, 'lazy_import', None)
if f is None:
f = _lazy_import_temp

return f(fullname)


# Copied from pulumi._utils.lazy_import, see comments there.
def _lazy_import_temp(fullname):
m = sys.modules.get(fullname, None)
if m is not None:
return m

spec = importlib.util.find_spec(fullname)

m = sys.modules.get(fullname, None)
if m is not None:
return m

loader = importlib.util.LazyLoader(spec.loader)
spec.loader = loader
module = importlib.util.module_from_spec(spec)

m = sys.modules.get(fullname, None)
if m is not None:
return m

sys.modules[fullname] = module
loader.exec_module(module)
return module


class Package(pulumi.runtime.ResourcePackage):
def __init__(self, pkg_info):
super().__init__()
self.pkg_info = pkg_info

def version(self):
return _version

def construct_provider(self, name: str, typ: str, urn: str) -> pulumi.ProviderResource:
if typ != self.pkg_info['token']:
raise Exception(f"unknown provider type {typ}")
Provider = getattr(lazy_import(self.pkg_info['fqn']), self.pkg_info['class'])
return Provider(name, pulumi.ResourceOptions(urn=urn))


class Module(pulumi.runtime.ResourceModule):
def __init__(self, mod_info):
super().__init__()
self.mod_info = mod_info

def version(self):
return _version

def construct(self, name: str, typ: str, urn: str) -> pulumi.Resource:
class_name = self.mod_info['classes'].get(typ, None)

if class_name is None:
raise Exception(f"unknown resource type {typ}")

TheClass = getattr(lazy_import(self.mod_info['fqn']), class_name)
return TheClass(name, pulumi.ResourceOptions(urn=urn))


def register(resource_modules, resource_packages):
resource_modules = json.loads(resource_modules)
resource_packages = json.loads(resource_packages)

for pkg_info in resource_packages:
pulumi.runtime.register_resource_package(pkg_info['pkg'], Package(pkg_info))

for mod_info in resource_modules:
pulumi.runtime.register_resource_module(
mod_info['pkg'],
mod_info['mod'],
Module(mod_info))


_F = typing.TypeVar('_F', bound=typing.Callable[..., typing.Any])


def lift_output_func(func: typing.Any) -> typing.Callable[[_F], _F]:
"""Decorator internally used on {fn}_output lifted function versions
to implement them automatically from the un-lifted function."""

func_sig = inspect.signature(func)

def lifted_func(*args, opts=None, **kwargs):
bound_args = func_sig.bind(*args, **kwargs)
# Convert tuple to list, see pulumi/pulumi#8172
args_list = list(bound_args.args)
return pulumi.Output.from_input({
'args': args_list,
'kwargs': bound_args.kwargs
}).apply(lambda resolved_args: func(*resolved_args['args'],
opts=opts,
**resolved_args['kwargs']))

return (lambda _: lifted_func)

def get_plugin_download_url():
return None