Skip to content

Fix -imports handling aliased imports in source mode#165

Merged
r-hang merged 4 commits intouber-go:mainfrom
mtoader:main
Nov 19, 2024
Merged

Fix -imports handling aliased imports in source mode#165
r-hang merged 4 commits intouber-go:mainfrom
mtoader:main

Conversation

@mtoader
Copy link
Copy Markdown

@mtoader mtoader commented Mar 6, 2024

In source mode, when generating a mock within the same package that uses names from a package that is imported with an alias, the generated mock should obey -imports properly and generate imports with the provided alias.

If the generated code is not using the same aliases as the main filed in a package the go compiler will still happily run but if you want ot use this package as a source in another package where you want to generate a mock, mock will fail because it will not know what to do with a package that is imported with two different names in a source package.

This patch fixes the generation by making -imports handling do a more correct thing.

It can be argued that the correct behavior is, by default use the the same package aliases as the ones in the source file, however that change looked way more invasive and i didn't see a good coverage of tests that would help me make sure the changes worked well.

This is what i found to be the least invasive fix for #166.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 6, 2024

CLA assistant check
All committers have signed the CLA.

@mtoader
Copy link
Copy Markdown
Author

mtoader commented Mar 19, 2024

@JacobOaks can you help with #166 and this ?

Copy link
Copy Markdown
Contributor

@r-hang r-hang left a comment

Choose a reason for hiding this comment

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

lgtm!

The net effect of this change will be that the gomock generated code should now follow the aliases specified by the -imports mapping. It does seem like this fixes a bug where definedImports is never looked-up by the full path that map is populated with.

@mtoader
Copy link
Copy Markdown
Author

mtoader commented Nov 12, 2024

@r-hang merged master into. Now it needs some maintainer approval

@mtoader
Copy link
Copy Markdown
Author

mtoader commented Nov 15, 2024

@r-hang I'm not that familiar with the reqs for the internal tests but i believe the latest commit might fix the tests. Can you approve the workflow run ?

@mtoader
Copy link
Copy Markdown
Author

mtoader commented Nov 18, 2024

@r-hang one more try. I did spend some time now to make sure the CI tooling does the right thing

@r-hang r-hang merged commit d97cf0d into uber-go:main Nov 19, 2024
@mtoader
Copy link
Copy Markdown
Author

mtoader commented Dec 5, 2024

When will there be a new release ?

@coderabbitai coderabbitai bot mentioned this pull request Apr 7, 2025
apricote pushed a commit to hetznercloud/fleeting-plugin-hetzner that referenced this pull request Apr 8, 2025
…eting-plugin-hetzner!238)

This MR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [go.uber.org/mock](https://github.com/uber/mock) | require | patch | `v0.5.0` -> `v0.5.1` |

---

### Release Notes

<details>
<summary>uber/mock (go.uber.org/mock)</summary>

### [`v0.5.1`](https://github.com/uber-go/mock/releases/tag/v0.5.1)

[Compare Source](uber-go/mock@v0.5.0...v0.5.1)

#### 0.5.1 (7 Apr 2025)

##### Fixed

-   [#&#8203;220][]: Package mode will now generate code that uses aliases of types
    when they are used in the source.
-   [#&#8203;219][]: Fixed a collision between function argument names and package names
    in generated code.
-   [#&#8203;165][]: Fixed an issue where aliases specified by `-imports` were not being
    respected in generated code.

[#&#8203;220]: uber-go/mock#220

[#&#8203;219]: uber-go/mock#219

[#&#8203;165]: uber-go/mock#165

Thanks to [@&#8203;mtoader](https://github.com/mtoader) and [@&#8203;bstncartwright](https://github.com/bstncartwright) for their contributions to this release.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMzUuMiIsInVwZGF0ZWRJblZlciI6IjM5LjIzNS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->
DennisRasey pushed a commit to DennisRasey/forgejo that referenced this pull request Apr 8, 2025
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [go.uber.org/mock](https://github.com/uber/mock) | require | patch | `v0.5.0` -> `v0.5.1` |

---

### Release Notes

<details>
<summary>uber/mock (go.uber.org/mock)</summary>

### [`v0.5.1`](https://github.com/uber-go/mock/releases/tag/v0.5.1)

[Compare Source](uber-go/mock@v0.5.0...v0.5.1)

#### 0.5.1 (7 Apr 2025)

##### Fixed

-   [#&#8203;220][]: Package mode will now generate code that uses aliases of types
    when they are used in the source.
-   [#&#8203;219][]: Fixed a collision between function argument names and package names
    in generated code.
-   [#&#8203;165][]: Fixed an issue where aliases specified by `-imports` were not being
    respected in generated code.

[#&#8203;220]: uber-go/mock#220

[#&#8203;219]: uber-go/mock#219

[#&#8203;165]: uber-go/mock#165

Thanks to [@&#8203;mtoader](https://github.com/mtoader) and [@&#8203;bstncartwright](https://github.com/bstncartwright) for their contributions to this release.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "* 0-3 * * *" (UTC), Automerge - "* 0-3 * * *" (UTC).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMzMuNSIsInVwZGF0ZWRJblZlciI6IjM5LjIzMy41IiwidGFyZ2V0QnJhbmNoIjoiZm9yZ2VqbyIsImxhYmVscyI6WyJkZXBlbmRlbmN5LXVwZ3JhZGUiLCJ0ZXN0L25vdC1uZWVkZWQiXX0=-->

Co-authored-by: Gusted <postmaster@gusted.xyz>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7488
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Renovate Bot <forgejo-renovate-action@forgejo.org>
Co-committed-by: Renovate Bot <forgejo-renovate-action@forgejo.org>
pableeee pushed a commit to pableeee/implgen that referenced this pull request Mar 7, 2026
In source mode, when generating a mock within the same package that uses
names from a package that is imported with an alias, the generated mock
should obey -imports properly and generate imports with the provided
alias.

If the generated code is not using the same aliases as the main filed in
a package the go compiler will still happily run but if you want ot use
this package as a source in another package where you want to generate a
mock, mock will fail because it will not know what to do with a package
that is imported with two different names in a source package.

This patch fixes the generation by making `-imports` handling do a more
correct thing.

It can be argued that the correct behavior is, by default use the the
same package aliases as the ones in the source file, however that change
looked way more invasive and i didn't see a good coverage of tests that
would help me make sure the changes worked well.

This is what i found to be the least invasive fix for uber-go#166.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants