Bugzilla – Full Text Bug Listing
| Summary: | [Installation] Make it easier to install Papyrus-RT | ||
|---|---|---|---|
| Product: | [Modeling] Papyrus-rt | Reporter: | Peter Cigehn <peter.cigehn> |
| Component: | General | Assignee: | Charles Rivet <charles> |
| Status: | CLOSED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | CC: | charles, papyrus-bugs |
| Version: | .7 | ||
| Target Milestone: | 0.8.0 | ||
| Hardware: | PC | ||
| OS: | Windows 7 | ||
| Whiteboard: | |||
| Attachments: | |||
|
Description
Peter Cigehn
Thanks, Peter, for the detailed instructions below. I have now created a new page in the Papyrus-RT wiki for this much simpler installation process. Note that I have run it on both Linux (Ubuntu 14.04) and Mac OS X 10.10.5 without problems. The User Guide (https://wiki.eclipse.org/Papyrus-RT/User_Guide) now shows the two approaches (I kept the previous one as parts of it could be useful when installing in an existing workbench). The new, Eclipse Installer based version is at https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer. Created attachment 257099 [details] Updated setup file that can install either 0.7.0 or a nightly build Considering the discussion in Bug 476237 Comment 21 and onwards, I realise that I was a bit unclear what the proposed .setup actually installs. The .setup file that I originally provided installed the nightly build of Papyrus-RT. For normal users I assume that we want them to install any of the releases. Attached is an updated setup file which now have two product versions: 0.7.0 and Nightly. Regarding the instructions on the Wiki I suggest a few improvements: 1) Instead of providing the .setup in a .zip file host the file "as-is" without zipping it. 2) If the .setup file is hosted "as-is", then I have understood that the Eclipse Installer can directly reference it using an URI. I have not tried this myself, but recommendations from Ed Merks on the Oomph user forum indicates that this is the recommended approach. Then the download, unzip and browsing to the unzipped/saved file can be removed, and instead one can paste a URI directly "Resource URI" file in the "Add User Products" dialog. When 0.7.1 has been released, then the hosted .setup file can simply be updated, without forcing the users to download and unzip an updated version of .setup-file. If you want to edit the .setup file when 0.7.1 have been released, then simply bring in the .setup file into the Papyrus-RT installation produced by the installer and just open it. This Papyrus-RT installation have al the needed Oomph components, including the .setup editor. Currently there are two product versions defined in the .setup model. Either change the 0.7.0 to 0.7.1 or provide a way of installing both 0.7.0 or 0.7.1 (and the Nightly). I'm reopening the Bugzilla to keep track of the proposed improvements in Comment 2. (In reply to Peter Cigehn from comment #2) > Created attachment 257099 [details] > Updated setup file that can install either 0.7.0 or a nightly build > > Considering the discussion in Bug 476237 Comment 21 and onwards, I realise > that I was a bit unclear what the proposed .setup actually installs. The > .setup file that I originally provided installed the nightly build of > Papyrus-RT. For normal users I assume that we want them to install any of > the releases. > > Attached is an updated setup file which now have two product versions: 0.7.0 > and Nightly. Thanks, I will update. > Regarding the instructions on the Wiki I suggest a few improvements: > > 1) Instead of providing the .setup in a .zip file host the file "as-is" > without zipping it. This can't be done through the wiki, which only accepts a limited set of extensions/file types. The file will have to be hosted elsewhere. At this point, and given the 0.7.1 release schedule (in 3 days), this would be a 0.8 change. > 2) If the .setup file is hosted "as-is", then I have understood that the > Eclipse Installer can directly reference it using an URI. I have not tried > this myself, but recommendations from Ed Merks on the Oomph user forum > indicates that this is the recommended approach. Then the download, unzip > and browsing to the unzipped/saved file can be removed, and instead one can > paste a URI directly "Resource URI" file in the "Add User Products" dialog. > > When 0.7.1 has been released, then the hosted .setup file can simply be > updated, without forcing the users to download and unzip an updated version > of .setup-file. > > If you want to edit the .setup file when 0.7.1 have been released, then > simply bring in the .setup file into the Papyrus-RT installation produced by > the installer and just open it. This Papyrus-RT installation have al the > needed Oomph components, including the .setup editor. > > Currently there are two product versions defined in the .setup model. Either > change the 0.7.0 to 0.7.1 or provide a way of installing both 0.7.0 or 0.7.1 > (and the Nightly). Updated Papyrus-RT.setup version on wiki. (In reply to Peter Cigehn from comment #2) > Created attachment 257099 [details] [...snip...] > > When 0.7.1 has been released, then the hosted .setup file can simply be > updated, without forcing the users to download and unzip an updated version > of .setup-file. > > If you want to edit the .setup file when 0.7.1 have been released, then > simply bring in the .setup file into the Papyrus-RT installation produced by > the installer and just open it. This Papyrus-RT installation have al the > needed Oomph components, including the .setup editor. > > Currently there are two product versions defined in the .setup model. Either > change the 0.7.0 to 0.7.1 or provide a way of installing both 0.7.0 or 0.7.1 > (and the Nightly). Plan would be to use a single "Mars" stream release repository. Users would then be able to simply update their installation from Eclipse, without having to run the installer. The default installation would then be to install the latest release. Release-specific repositories would be kept, so it should be possible to install previous versions in the same stream, if desired. (In reply to Charles Rivet from comment #6) > Plan would be to use a single "Mars" stream release repository. Users would > then be able to simply update their installation from Eclipse, without > having to run the installer. The default installation would then be to > install the latest release. Release-specific repositories would be kept, so > it should be possible to install previous versions in the same stream, if > desired. Okay, what is the plan to switch over to the Neon track? I guess that at some point we should base Papyrus-RT on Papyrus Neon. Is that post-0.8? Yes, it will be post 0.8 (I suspect the first thing after 0.8 is released). Something has changed with the configuration of a newly downloaded Eclipse Installer, which causes the user product category to not be listed in simple mode any longer. At least when I download a new Windows Installer (both the 32-bit and 64-bit version). I am not sure why it worked back we tested this initially. But to my understanding it is currently only the products in the Eclipse.org product category that is shown in simple mode (using filters that are set in the config.ini in the configuration area of the installer itself). Only in advanced mode you can see the User and Eclipse.org Application product categories. So instead of switching back to simple mode after adding the Papyrus-RT specific .setup file at step 9, the installation have to be made in advanced mode. The only difference in advanced mode is that it does not seem to be any support for automatically creating a start menu entry and a desktop shortcut, and it is a few more pages to go through in the wizard. Step 12-13 can be exchanged with the following instead: a) Select which product version to install b) Click the "Next" button c) Skip the page with Projects and click simply click the "Next" button d) On the page with variables click the checkbox "Show all variables" and ensure that the "Root install location" is a suitable location. e) Click the "Next" button f) On the Confirmation page press the "Finish" button. (In reply to Peter Cigehn from comment #9) > Something has changed with the configuration of a newly downloaded Eclipse > Installer, which causes the user product category to not be listed in simple > mode any longer. At least when I download a new Windows Installer (both the > 32-bit and 64-bit version). [...Snip...] What was the version of the Eclipse Installer you used? Which version I used when I initially got it working also in simple mode I do not remember (I think it was the one for Mars). Now when I realized that it didn't work any longer I tried all the different Windows versions, i.e. both the version for Mars and the one for Neon, and both the 32-bit and the 64-bit version in both cases. When I check the config.ini file in the configuration area of the installation of the installer I can see the same kind of filter regarding product category. Only difference between the Mars and Neon installer is a version filter. Now I think I understand what is going on. The Eclipse Installer provided by EPP at the top of the page at http://www.eclipse.org/downloads/ is configured with filters that only shows the Eclipse.org product category in simple mode. But if you instead download the "base" Eclipse Installer as provided at https://wiki.eclipse.org/Eclipse_Installer there is no such filter configured. When checking the config.ini file in the configuration area of the installation, the filters are empty in this packaging of the Eclipse Installer. So what we need to do is to update the installation guide at https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer and the first step how to install the Eclipse Installer to provide the link https://wiki.eclipse.org/Eclipse_Installer instead (at step 1 in the section 'Install the Eclipse Installer'). Then the rest of the guide I assume should still work, since it is possible to switch back to the simple mode and still have the user product category and its product configurations to show up at the top of the list as shown in the screen shots. I guess that the Eclipse Installer that was provided via http://www.eclipse.org/downloads/ possibly could have been "misconfigured" during a period of time when we initially tried this out. PS. I saw that you had added the p2 repo for CDT to the .setup-file, and also added the recommendation in the guide to install CDT as well, but not actually added the CDT feature to the installation. Why not simply make sure that CDT is installed also? I added that to my own version of the .setup-file and it works fine. Just add a new "Requirement" child the P2 Director with the name "org.eclipse.cdt.feature.group". Add it to the top level P2 Director to install it for all versionsm, and add suitable repos, e.g. 8.8 version for 0.7.0 and 0.7.1 and possibly some nightly repo for the nightly of Papyrus-RT. DS. (In reply to Peter Cigehn from comment #12) >Which version I used when I initially got it working also in simple mode I do >not remember (I think it was the one for Mars). Now when I realized that it >didn't work any longer I tried all the different Windows versions, i.e. both >the version for Mars and the one for Neon, and both the 32-bit and the 64-bit >version in both cases. The version of the installer is shown one of the dialogs as you run it. I found this strange as I ran the installation from scratch on Linux last Monday and did not have the problem you describe. Note that I updated the installer in place and did not download a new installer. Perhaps that is significant. >When I check the config.ini file in the configuration area of the installation >of the installer I can see the same kind of filter regarding product category. >Only difference between the Mars and Neon installer is a version filter. Note that Papyrus-RT does not yet support Neon. (In reply to Peter Cigehn from comment #12) > Now I think I understand what is going on. The Eclipse Installer provided by > EPP at the top of the page at http://www.eclipse.org/downloads/ is > configured with filters that only shows the Eclipse.org product category in > simple mode. > > But if you instead download the "base" Eclipse Installer as provided at > https://wiki.eclipse.org/Eclipse_Installer there is no such filter > configured. When checking the config.ini file in the configuration area of > the installation, the filters are empty in this packaging of the Eclipse > Installer. > > So what we need to do is to update the installation guide at > https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer and the > first step how to install the Eclipse Installer to provide the link > https://wiki.eclipse.org/Eclipse_Installer instead (at step 1 in the section > 'Install the Eclipse Installer'). I actually like this link better - thanks! Updated. > Then the rest of the guide I assume should still work, since it is possible > to switch back to the simple mode and still have the user product category > and its product configurations to show up at the top of the list as shown in > the screen shots. > > I guess that the Eclipse Installer that was provided via > http://www.eclipse.org/downloads/ possibly could have been "misconfigured" > during a period of time when we initially tried this out. > > PS. I saw that you had added the p2 repo for CDT to the .setup-file, and > also added the recommendation in the guide to install CDT as well, but not > actually added the CDT feature to the installation. Why not simply make sure > that CDT is installed also? I added that to my own version of the > .setup-file and it works fine. Just add a new "Requirement" child the P2 > Director with the name "org.eclipse.cdt.feature.group". Add it to the top > level P2 Director to install it for all versionsm, and add suitable repos, > e.g. 8.8 version for 0.7.0 and 0.7.1 and possibly some nightly repo for the > nightly of Papyrus-RT. DS. That was just preliminary work and I ran out of time to finish it up after I ran into a bug. I will look at it soon (sooner if you send me a patch for it...or your setup file...). (In reply to Charles Rivet from comment #13) > Note that I updated the > installer in place and did not download a new installer. Perhaps that is > significant. That is definitively significant. The config.ini file I guess is not updated, when making an update in place. So you only see this for new fresh installs of the Eclipse Installer. I discovered all this when I made a downloaded the 64-bit version and it behaved differently from the 32-bit version I had installed from before (but still updated to the latest version). Then I downloaded the 32-bit version again and reinstalled from scratch, and discovered this issue. (In reply to Charles Rivet from comment #13) > That was just preliminary work and I ran out of time to finish it up after I > ran into a bug. I will look at it soon (sooner if you send me a patch for > it...or your setup file...). I started to look into updating the .setup-file and provide an updated version, but I bumped into a number of issues with the changes that you had made. So I am not sure really how to proceed. The change that I had in mind was basically just to add the repository for CDT 8.8 and the CDT feature to the top level P2 Director in the .setup-file, which would ensure that CDT 8.8 was installed for all the three different versions, 0.7.0, 0.7.1, and Nightly. But you had made a number of changes compared to my initial proposal, which I don't know how to proceed with: 1) You had removed the repository https://hudson.eclipse.org/papyrus-rt/job/Papyrus-RT-Master-All/lastSuccessfulBuild/artifact/repository/ from Nightly which in practice makes it impossible to install the nightly version since the only remaining repository http://download.eclipse.org/papyrus-rt/builds/nightly/ only contains the code-generator and the run-time. Not sure why this was made, and we have discussed this issue numerous times, so there still seem to be some uncertainties which repositories to use to install a nightly version of Papyrus-RT including the tooling. Anyway, the current situation is that you cannot install the nightly version using the .setup-file provided at https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer 2) You had also changed repository for Papyrus http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars to be more specific and select a detailed version of Papyrus for 0.7.0 and 0.7.1 of Papyrus-RT. I can see the intention, but the problem is that this will not work. Even if you specify that Papyrus 1.1.1 shall be used for Papyrus-RT 0.7.0, Papyrus 1.1.2 will still be installed since Papyrus 1.1.2 is part of the http://download.eclipse.org/releases/mars repository (since Papyrus is part of the Eclipse release train). So even if a repository for 1.1.1 is specified, 1.1.2 will still be installed. 3) To avoid the confusion described in 2) I simply removed the http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars/1.1.2/ and http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars/1.1.1 repositories from the 0.7.1 respectively 0.7.0. But then you bump into the issue that the code-generator has direct dependency on the C++ Profile plugin that is part of the Extras Components of Papyrus, the installation fails due to that this dependency cannot be resolved. I am not fully sure, but I guess this dependency cannot be resolved since we do not added an explicit a requirement on its feature in the P2 Director in the .setup-file. I am not sure how we shall deal with this dependency in general. Since I am not sure how things are going to be structured in which repositories and what feature requirements really should be configured, I am not sure how to proceed really. (In reply to Charles Rivet from comment #4) > (In reply to Peter Cigehn from comment #2) > > Regarding the instructions on the Wiki I suggest a few improvements: > > > > 1) Instead of providing the .setup in a .zip file host the file "as-is" > > without zipping it. > > This can't be done through the wiki, which only accepts a limited set of > extensions/file types. The file will have to be hosted elsewhere. At this > point, and given the 0.7.1 release schedule (in 3 days), this would be a 0.8 > change. > Regarding the hosting of the .setup-file I suggest that you simply put the setup file into the Papyrus-RT Git Repo and then use the plain URL to file in the Git repo at http://git.eclipse.org/c/papyrus-rt/org.eclipse.papyrus-rt.git/ Then we can at least get away from the aspect of users have to download the setup-file (and unzip it) and instead the user can simply paste a URL directly to the file in the Git repo. Which I then also assume that we can simply update the setup file and push it to the Git repo, and it will automatically be available to all users (without having them to download a new version). This is the approached when different projects provide their own setup models to be included in the project catalog. See https://wiki.eclipse.org/Eclipse_Oomph_Authoring#Contributing_to_a_Project_Catalog for more information. I guess that we as a next step could try the same way of contributing to the application catalog, to get the Papyrus-RT product setup to be included directly in the catalog (which means we can get away from the manual steps of adding the setup file since it will be included in the same way as the current setup for Papyrus with CDO). (In reply to Peter Cigehn from comment #15) > 3) To avoid the confusion described in 2) I simply removed the > http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars/1.1.2/ > and > http://download.eclipse.org/modeling/mdt/papyrus/updates/releases/mars/1.1.1 > repositories from the 0.7.1 respectively 0.7.0. But then you bump into the > issue that the code-generator has direct dependency on the C++ Profile > plugin that is part of the Extras Components of Papyrus, the installation > fails due to that this dependency cannot be resolved. I am not fully sure, > but I guess this dependency cannot be resolved since we do not added an > explicit a requirement on its feature in the P2 Director in the .setup-file. > I am not sure how we shall deal with this dependency in general. I think that the reason for the dependency on the C++ Profile not being possible to resolve when you remove the separate Papyrus repo, is that only base Papyrus, and not any of the extras components, are part of the main release repo http://download.eclipse.org/releases/mars. So there is a need to include the Papyrus repo to be able to install extras components (but not needed for base Papyrus itself). I guess this can cause some major confusion, if there is a need to install a very specific version of Papyrus as you tried to update the setup-file. Not really sure how to resolve this. Created attachment 257681 [details] Updated setup file to ensure correct version of Papyrus, as well as installing CDT I think that I have come up with a way to solve the issue of installing the correct version of base Papyrus for Papyrus-RT 0.7.0 respectively 0.7.1. By adding version range to the feature requirement of Papyrus, it is possible to ensure that Paparys 1.1.1 is installed for Papyrus-RT 0.7.0. So the changes I made to the setup file provided at https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer is the following: 1) Add repository for CDT 8.8 and feature requirement to top level P2 Director to ensure that CDT 8.8 is installed for all three version (0.7.0, 0.7.1 and Nightly) 2) Removed the individual features for core, profile and tooling, and only have the top level Papyrus-RT feature 3) Moved/copied this base Papyrus feature to each of the versions 0.7.0, 0.7.1 and Nightly. Added version range to install 1.1.1 for 0.7.0 and 1.1.2 for 0.7.1. 4) Re-added the repository https://hudson.eclipse.org/papyrus-rt/job/Papyrus-RT-Master-All/lastSuccessfulBuild/artifact/repository/ to make it possible to install the nightly of Papyrus-RT again (needed for the core, profile and tooling part, since the repo http://download.eclipse.org/papyrus-rt/builds/nightly/ only contains code-generator and run-time) 5) Changed the description of the Papyrus-RT product back to my initial proposal and added the fact that also CDT is installed. I suggest that this .setup-file is added to some appropriate location in the Git repo according to Comment 16 (I guess somewhere under releng is good location). Added new configuration file (thanks Peter) to the wiki and updated steps. Still trying to determinate a better way to provide the file than through the wiki, to make it easier for users - some concerns about"releng, which may not be the best approach. Current process is easy enough for now, but should be revisited for 1.0. (In reply to Charles Rivet from comment #19) > Still trying to determinate a better way to provide the file than through > the wiki, to make it easier for users - some concerns about"releng, which > may not be the best approach. Well, this about putting under "releng" was just a proposal based on where the .setup file used for setting up the development environment for Papyrus is placed in the Papyrus repo. http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/plain/releng/org.eclipse.papyrus.oomph/setups/papyrus.setup I really do not have any opinion of *where* in the Git repo it shall be placed. The main aspect is that the .setup file is put in the Git repo and then can be accessed using http://git.eclipse.org/c/... Papyrus-RT.setup file now under source control by Change 60649 (https://git.eclipse.org/r/60649). This will allow changes to be track with new releases. Installation instructions on Wiki (https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer#Download_the_Papyrus-RT_configuration_file) have been updated to get the setup file directly from the development repository instead of the wiki files area. It should be understood that this is a temporary measure until Papyrus-RT gets included in the Eclipse Installer's component library (probably after Papyrus-RT is out of incubation). (In reply to Charles Rivet from comment #21) > Installation instructions on Wiki > (https://wiki.eclipse.org/Papyrus-RT/User_Guide/ > Eclipse_Installer#Download_the_Papyrus-RT_configuration_file) have been > updated to get the setup file directly from the development repository > instead of the wiki files area. I would suggest to even further simplify it for users. Since there is no need to download the .setup-file and "force" users to have their own copy of the .setup-file, the instructions can be further simplified. At the step "Setup Papyrus-RT configuration" https://wiki.eclipse.org/Papyrus-RT/User_Guide/Eclipse_Installer#Set_up_the_Papyrus-RT_configuration the user can simply paste in the following URI into the "Resource URIs" field http://git.eclipse.org/c/papyrus-rt/org.eclipse.papyrus-rt.git/plain/releng/org.eclipse.papyrus-rt.oomph/setups/Papyrus-RT.setup There is no need to download the .setup-file beforehand, and thus no need to browse to it using the the "Browse File System..." button. The benefit of this is also that when 0.8.0 is released, then the users that already have setup/configured their Eclipse Installer, can simply start the installer again and they will automatically have the option of installing Papyrus-RT 0.8.0. Reworked the installation instructions to directly access the setup file from the Papyrus-RT repository. The installation has been simplified using the Eclipse installer. This Bugzilla can be considered verified fixed. Any additional and further simplifications to the installation of Papyrus-RT can be tracked in separate Bugzilla(s). Bug creator verified fix. |