Make chisel a build snap #464

linostar · 2024-01-25T10:56:14Z

Have you signed the CLA?

Chisel isn't wanted to be embedded in rockcraft snap, so it is set to be a build-snap instead.

linostar · 2024-01-26T08:26:04Z

Here are successful examples of running rockcraft pack after this PR change:

"Hello World" tutorial (rockcraft.yaml that has slices)

Starting rockcraft                                                                                                                                                                                        
Logging execution to '/root/.local/state/rockcraft/log/rockcraft-20240126-081459.767870.log'                                                                                                              
Launching managed ubuntu 22.04 instance...                                                                                                                                                                
Creating instance from base instance                                                                                                                                                                      
Starting instance                                                                                                                                                                                         
Starting rockcraft                                                                                                                                                                                        
Logging execution to '/tmp/rockcraft.log'                                                                                                                                                                 
Extracting bare:latest                                                                                                                                                                                    
Extracted bare:latest                                                                                                                                                                                     
Initialising lifecycle                                                                                                                                                                                    
Installing build-packages                                                                                                                                                                                 
Pulling hello                                                                                                                                                                                             
Fetching stage-packages                                                                                                                                                                                   
Pulling pebble                                                                                                                                                                                            
Overlaying hello                                                                                                                                                                                          
Overlaying pebble                                                                                                                                                                                         
Building hello                                                                                                                                                                                            
Building pebble                                                                                                                                                                                           
Staging hello                                                                                                                                                                                             
Staging pebble                                                                                                                                                                                            
Priming hello                                                                                                                                                                                             
Priming pebble                                                                                                                                                                                            
:: + craftctl default                                                                                                                                                                                     
:: + mkdir -p var/lib/pebble/default/layers                                                                                                                                                               
Packing...                                                                                                                                                                                                
Creating new layer                                                                                                                                                                                        
Created new layer                                                                                                                                                                                         
Adding Pebble entrypoint                                                                                                                                                                                  
Configuring entrypoint...                                                                                                                                                                                 
Entrypoint set to ['/bin/pebble', 'enter', '--verbose']                                                                                                                                                   
Adding metadata                                                                                                                                                                                           
Configuring labels and annotations...                                                                                                                                                                     
Labels and annotations set to ['org.opencontainers.image.version=1.0', 'org.opencontainers.image.title=hello', 'org.opencontainers.image.ref.name=hello', 'org.opencontainers.image.licenses=Apache-2.0', 'org.opencontainers.image.created=2024-01-26T08:16:08.731117+00:00', 'org.opencontainers.image.base.digest=08dd2aa57bdccd24cd3342b1a8b4f024bc63ce995411a189dbe9d9e9d0f954e5']                              
Setting the rock's control data                                                                                                                                                                           
Control data written                                                                                                                                                                                      
Metadata added                                                                                                                                                                                            
Exporting to OCI archive                                                                                                                                                                                  
Exported to OCI archive 'hello_1.0_amd64.rock'                                                                                                                                                            
Packed hello_1.0_amd64.rock

Node.js app tutorial (rockcraft.yaml without slices)

Starting rockcraft
Logging execution to '/root/.local/state/rockcraft/log/rockcraft-20240126-082323.896225.log'
Launching managed ubuntu 22.04 instance...
Creating instance from base instance
Starting instance
Starting rockcraft
Logging execution to '/tmp/rockcraft.log'
Retrieving base [email protected] for amd64
Retrieved base [email protected] for amd64
Extracting ubuntu:22.04
Extracted ubuntu:22.04
Initialising lifecycle
Installing build-packages
Pulling app
Pulling pebble
Overlaying app
Overlaying pebble
Building app
:: + '[' '!' -f /root/parts/app/install/bin/node ']'
:: + curl -s https://nodejs.org/dist/v21.1.0/node-v21.1.0-linux-x64.tar.gz
:: + tar xzf - -C /root/parts/app/install/ --no-same-owner --strip-components=1
:: ++ npm pack .
:: ++ tail -1
:: npm notice
:: npm notice 📦  [email protected]
:: npm notice === Tarball Details ===                                                                                                                                                                     
:: npm notice name:          node_web_app                                                                                                                                                                 
:: npm notice version:       1.0.0                                                                                                                                                                        
:: npm notice filename:      node_web_app-1.0.0.tgz                                                                                                                                                       
:: npm notice package size:  458 B                                                                                                                                                                        
:: npm notice unpacked size: 569 B                                                                                                                                                                        
:: npm notice shasum:        4b08267096e1706a4e4b686641c5d6abc72e3cd9                                                                                                                                     
:: npm notice integrity:     sha512-grSoUXqxxCaAi[...]fILWatiXa/Q9g==                                                                                                                                     
:: npm notice total files:   2                                                                                                                                                                            
:: npm notice                                                                                                                                                                                             
:: + npm install -g --prefix /root/parts/app/install node_web_app-1.0.0.tgz                                                                                                                               
::                                                                                                                                                                                                        
:: added 63 packages in 3s                                                                                                                                                                                
::                                                                                                                                                                                                        
:: 11 packages are looking for funding                                                                                                                                                                    
::   run `npm fund` for details                                                                                                                                                                           
:: npm notice                                                                                                                                                                                             
:: npm notice New minor version of npm available! 10.2.0 -> 10.4.0                                                                                                                                        
:: npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>                                                                                                                                
:: npm notice Run `npm install -g [email protected]` to update!                                                                                                                                                  
:: npm notice                                                                                                                                                                                             
Building pebble                                                                                                                                                                                           
Staging app                                                                                                                                                                                               
Staging pebble                                                                                                                                                                                            
Priming app                                                                                                                                                                                               
Priming pebble                                                                                                                                                                                            
:: + craftctl default                                                                                                                                                                                     
:: + mkdir -p var/lib/pebble/default/layers                                                                                                                                                               
Packing...                                                                                                                                                                                                
Creating new layer                                                                                                                                                                                        
Created new layer                                                                                                                                                                                         
Adding Pebble entrypoint                                                                                                                                                                                  
Configuring entrypoint...                                                                                                                                                                                 
Entrypoint set to ['/bin/pebble', 'enter', '--verbose']                                                                                                                                                   
Configuring Pebble services app                                                                                                                                                                           
Found 0 Pebble layers in the base's root filesystem                                                                                                                                                       
Preparing new Pebble layer file 001-my-node-app.yaml                                                                                                                                                      
Writing new Pebble layer file                                                                                                                                                                             
Adding metadata                                                                                                                                                                                           
Configuring labels and annotations...                                                                                                                                                                     
Labels and annotations set to ['org.opencontainers.image.version=1.0', 'org.opencontainers.image.title=my-node-app', 'org.opencontainers.image.ref.name=my-node-app', 'org.opencontainers.image.licenses=GPL-3.0', 'org.opencontainers.image.created=2024-01-26T08:25:04.369867+00:00', 'org.opencontainers.image.base.digest=1ea0c67060c5054fa74789f089d27f01442588e8874159de1c7aa61fb6bf70fc']                     
Setting the rock's control data                                                                                                                                                                           
Control data written                                                                                                                                                                                      
Metadata added                                                                                                                                                                                            
Exporting to OCI archive                                                                                                                                                                                  
Exported to OCI archive 'my-node-app_1.0_amd64.rock'                                                                                                                                                      
Packed my-node-app_1.0_amd64.rock

linostar · 2024-01-26T08:32:56Z

@cjdcordeiro @tigarmo This is ready for review. See examples of running it above.

Before merging this, PR #637 needs to be merged first, and function part_has_slices need to be removed from rockcraft afterwards in the current PR.

cjdcordeiro

Nice. Short and sweet. I'm adding a label to be explicit that canonical/craft-parts#637 should be merged first

cjdcordeiro · 2024-01-26T11:04:37Z

rockcraft/services/lifecycle.py

+        # this will be removed once part_has_slices is added to craft-parts
+        def part_has_slices(data: dict[str, Any]) -> bool:
+            stage_packages = data.get("stage-packages", [])
+            return any(name for name in stage_packages if "_" in name)
+


still within this PR right? Since we're waiting for canonical/craft-parts#637

cjdcordeiro · 2024-01-26T11:05:09Z

rockcraft/services/lifecycle.py


        services = cast(RockcraftServiceFactory, self._services)
        image_service = services.image
        image_info = image_service.obtain_image()
+        needs_chisel = any(part for part in parts if part_has_slices(parts[part]))


I guess this will also slightly change after canonical/craft-parts#637

yes, it will become craft_parts.part_has_slices instead.

We can move detection and chisel installing to craft-parts, it already does that with other tools such as git.

tigarmo · 2024-01-29T13:03:54Z

rockcraft/services/lifecycle.py


+        if needs_chisel:
+            self._manager_kwargs.update(
+                extra_build_snaps=["chisel/latest/candidate"],


I'm a bit worried about using a "dynamic" candidate snap here. Is there a plan/timeline for stable chisel?

Not before 13th of Feb, but most likely towards the end of that month.

I had a discussion with Cris about this, and he said it's ok if we wait until chisel stable is released before we merge this one.

clay-lake · 2024-08-28T12:31:36Z

Hey everyone. I wanted to check in on this PR; I'm worried its getting a little stale.
Should we keep it open?

🦇

linostar · 2024-08-28T12:46:57Z

Hey everyone. I wanted to check in on this PR; I'm worried its getting a little stale. Should we keep it open?

🦇

We're still waiting for chisel to release its first stable release, so I guess let's keep it open until then.

docs/how-to/code/install-slice/rockcraft.yaml

linostar force-pushed the ROCKS-936/make-rockcraft-pull-chisel-at-pack-time branch from b473145 to 6829757 Compare January 25, 2024 18:01

linostar marked this pull request as ready for review January 26, 2024 08:39

Make chisel a build snap

4248878

linostar force-pushed the ROCKS-936/make-rockcraft-pull-chisel-at-pack-time branch from cfddc15 to 4248878 Compare January 26, 2024 08:58

cjdcordeiro requested review from tigarmo and cjdcordeiro January 26, 2024 10:52

cjdcordeiro assigned tigarmo Jan 26, 2024

cjdcordeiro approved these changes Jan 26, 2024

View reviewed changes

cjdcordeiro added the do-not-merge label Jan 26, 2024

tigarmo reviewed Jan 29, 2024

View reviewed changes

linostar mentioned this pull request Jan 30, 2024

feat: add a utility function that determines whether a part has slices canonical/craft-parts#637

Open

1 task

tigarmo mentioned this pull request Feb 5, 2024

Install chisel if parts use slices canonical/craft-parts#649

Open

lengau reviewed Aug 28, 2024

View reviewed changes

docs/how-to/code/install-slice/rockcraft.yaml Outdated Show resolved Hide resolved

Replace stage-snaps with build-snaps for chisel

ac66b7a

github-actions bot added the documentation Improvements or additions to documentation label Aug 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make chisel a build snap #464

Make chisel a build snap #464

linostar commented Jan 25, 2024

linostar commented Jan 26, 2024

linostar commented Jan 26, 2024

cjdcordeiro left a comment

cjdcordeiro Jan 26, 2024

linostar Jan 26, 2024

cjdcordeiro Jan 26, 2024

linostar Jan 26, 2024

cmatsuoka Feb 1, 2024

tigarmo Jan 29, 2024

linostar Jan 29, 2024

linostar Jan 29, 2024

clay-lake commented Aug 28, 2024

linostar commented Aug 28, 2024

Make chisel a build snap #464

Are you sure you want to change the base?

Make chisel a build snap #464

Conversation

linostar commented Jan 25, 2024

linostar commented Jan 26, 2024

linostar commented Jan 26, 2024

cjdcordeiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clay-lake commented Aug 28, 2024

linostar commented Aug 28, 2024