Fix upload crash when run outside project directory#2497
Draft
Copilot wants to merge 10 commits intohotfix/4.1from
Draft
Fix upload crash when run outside project directory#2497Copilot wants to merge 10 commits intohotfix/4.1from
Copilot wants to merge 10 commits intohotfix/4.1from
Conversation
Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix charmcraft internal error on upload outside project directory
Fix upload crash when run outside project directory
Dec 3, 2025
|
Type checking with Command output |
Collaborator
|
@copilot before committing any changes, |
Copilot stopped work on behalf of
lengau due to an error
December 3, 2025 19:18
Collaborator
|
@copilot fix the lint errors |
Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Contributor
Author
Fixed in 72d15d3. The mypy error was due to an incorrect type annotation in the Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Collaborator
|
@copilot create a spread test that checks this. |
Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Contributor
Author
lengau
reviewed
Dec 8, 2025
|
|
||
| prepare: | | ||
| tests.pkgs install jq | ||
| charmcraft init --project-dir=charm --name=$CHARM_DEFAULT_NAME --profile=machine |
Collaborator
There was a problem hiding this comment.
@copilot instead of doing this, include a minimal charmcraft.yaml file in this directory.
Contributor
Author
There was a problem hiding this comment.
Updated in 6d134ba. The test now includes a minimal charmcraft.yaml file directly in the test directory instead of full charm subdirectory structure.
Instead of using charmcraft init, include charm/ and upload-dir/ subdirectories with pre-existing charmcraft.yaml file. This follows the pattern used in other spread tests. Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Instead of including full charm/ subdirectory structure, include only a minimal charmcraft.yaml file in the test directory and use charmcraft init to create the charm structure, then copy the minimal config. Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
Contributor
Author
Fixed in 72d15d3. The mypy error was due to an incorrect type annotation in the
Created spread test in 424a6c4, updated to use pre-existing subdirectories in 3bb3a2c, and simplified to use minimal charmcraft.yaml in 6d134ba. |
lengau
reviewed
Dec 8, 2025
| channel: "22.04" | ||
| run-on: | ||
| - name: ubuntu | ||
| channel: "22.04" |
Collaborator
There was a problem hiding this comment.
@copilot add a part here with plugin nil so that we don't spend a long time building
Contributor
Author
There was a problem hiding this comment.
Added in 22a5375. The charmcraft.yaml now includes a parts section with plugin: nil to speed up the build.
Add a parts section with plugin: nil to avoid spending time on unnecessary build operations during the spread test. Co-authored-by: lengau <4305943+lengau@users.noreply.github.com>
|
Type checking with Command output |
1 similar comment
|
Type checking with Command output |
|
Type checking with Command output |
|
Type checking with Command output |
lengau
reviewed
Dec 11, 2025
|
|
||
| # Initialize a charm project and use our minimal charmcraft.yaml | ||
| charmcraft init --project-dir=charm | ||
| cp charmcraft.yaml charm/charmcraft.yaml |
Collaborator
There was a problem hiding this comment.
2025-12-08 21:54:36 Error preparing google:ubuntu-22.04-64:tests/spread/store/upload-outside-project (dec082151-659570) :
-----
+ tests.pkgs install jq
+ apt-get update
Hit:1 http://us-east1.gce.archive.ubuntu.com/ubuntu jammy InRelease
Hit:2 http://us-east1.gce.archive.ubuntu.com/ubuntu jammy-updates InRelease
Hit:3 http://us-east1.gce.archive.ubuntu.com/ubuntu jammy-backports InRelease
Hit:4 http://security.ubuntu.com/ubuntu jammy-security InRelease
Reading package lists...
+ apt-get install --yes jq
Reading package lists...
Building dependency tree...
Reading state information...
jq is already the newest version (1.6-2.1ubuntu3.1).
0 upgraded, 0 newly installed, 0 to remove and 0 not upgraded.
+ set +x
+ charmcraft init --project-dir=charm
2025-12-08 21:54:35.764 Starting charmcraft, version 4.0.0.post38+gdf7ef869.d20251208
2025-12-08 21:54:35.764 Logging execution to '/root/.local/state/charmcraft/log/charmcraft-20251208-215435.763030.log'
2025-12-08 21:54:35.764 Log verbosity level set to DEBUG
2025-12-08 21:54:35.764 Setting up CharmBuildPlanService
2025-12-08 21:54:35.764 Setting up ProjectService
2025-12-08 21:54:35.772 Preparing application...
2025-12-08 21:54:35.772 Setting up ConfigService
2025-12-08 21:54:35.773 Configuring application...
2025-12-08 21:54:35.773 Getting runtime directory.
2025-12-08 21:54:35.773 Using '/run/user/0/4525' for the state directory.
2025-12-08 21:54:35.773 Setting up StateService
2025-12-08 21:54:35.773 Setting 'charmcraft.started_at' to '2025-12-08T21:54:35.773611'.
2025-12-08 21:54:35.773 Loading state file '/run/user/0/4525/charmcraft.yaml'.
2025-12-08 21:54:35.773 State file doesn't exist.
2025-12-08 21:54:35.773 Writing state to '/run/user/0/4525/charmcraft.yaml'.
2025-12-08 21:54:35.774 Set 'charmcraft.started_at' to '2025-12-08T21:54:35.773611'.
2025-12-08 21:54:35.775 Configuring application...
2025-12-08 21:54:35.776 Setting 'charmcraft.started_at' to '2025-12-08T21:54:35.776055'.
2025-12-08 21:54:35.776 Loading state file '/run/user/0/4525/charmcraft.yaml'.
2025-12-08 21:54:35.776 Overwriting existing value.
2025-12-08 21:54:35.777 Writing state to '/run/user/0/4525/charmcraft.yaml'.
2025-12-08 21:54:35.777 Set 'charmcraft.started_at' to '2025-12-08T21:54:35.776055'.
2025-12-08 21:54:35.799 Build plan: platform=None, build_for=None
2025-12-08 21:54:35.800 Running charmcraft init on host
2025-12-08 21:54:35.800 Using project directory '/charmcraft/tests/spread/store/upload-outside-project/charm'
2025-12-08 21:54:35.800 Set project name to 'charm'
2025-12-08 21:54:35.804 Rendering .gitignore
2025-12-08 21:54:35.805 Rendering CONTRIBUTING.md
2025-12-08 21:54:35.809 Rendering LICENSE
2025-12-08 21:54:35.811 Rendering README.md
2025-12-08 21:54:35.812 Rendering charmcraft.yaml
2025-12-08 21:54:35.814 Rendering pyproject.toml
2025-12-08 21:54:35.817 Rendering src/charm.py
2025-12-08 21:54:35.817 made executable
2025-12-08 21:54:35.818 Rendering src/workload.py
2025-12-08 21:54:35.820 Rendering tests/integration/conftest.py
2025-12-08 21:54:35.822 Rendering tests/integration/test_charm.py
2025-12-08 21:54:35.825 Rendering tests/unit/test_charm.py
2025-12-08 21:54:35.826 Rendering tox.ini
2025-12-08 21:54:35.838 Rendering uv.lock
Charmed operator package file and directory tree initialised.
Now edit the following package files to provide fundamental charm metadata
and other information:
charmcraft.yaml
src/charm.py
src/workload.py
README.md
To manage your charm's dependencies, use uv.
To migrate from the Charm plugin to the uv plugin, see:
https://documentation.ubuntu.com/charmcraft/stable/howto/migrate-plugins/charm-to-uv/
+ cp charmcraft.yaml charm/charmcraft.yaml
cp: cannot stat 'charmcraft.yaml': No such file or directory
-----
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixed a bug where
charmcraft uploadcrashes withRuntimeError("Project not configured yet.")when run outside a directory containingcharmcraft.yaml.Root Cause
The
UploadCommand.needs_project()method checks ifcharmcraft.yamlexists, but this doesn't mean the project service will be configured. After a successful upload, the code tried to check for unpublished charm libraries without first checking if the project was configured.Solution
Check
project_service.is_configuredbefore callingproject_service.get()to ensure the project is configured before accessing it.Changes Made
UploadCommand.run()incharmcraft/application/commands/store.pyto check if project is configured before accessing ittest_upload_without_configured_projectintests/unit/commands/test_store.pyto verify the fixUploaded.statusfield frominttostrincharmcraft/store/models.pyto resolve mypy lint errortests/spread/store/upload-outside-project/for end-to-end integration testing:charmcraft.yamlfile with staging store configuration andplugin: nilfor fast buildstask.yamlthat usescharmcraft initto create a charm, copies the minimal config, packs the charm, moves it outside the project directory, and uploads itTesting
charmcraft.yamlusing the nil plugin for fast builds, packs it in the project directory, moves the charm file to a directory withoutcharmcraft.yaml, and uploads from outside the project directory to verify no crash occursNotes
The bug is in charmcraft, not craft-application. The craft-application library is working as designed by raising a RuntimeError when trying to get an unconfigured project.
make lint && make test.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.