adfemg
  1. adfemg
  2. ADFEMG-88

[ADFng1-02008] - Application level deployment profile names

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Labels:
      None

      Description

      hi

      Please consider naming guideline [ADFng1-02008] in the "ADF Naming and Project Layout Guidelines v1.00" [1].

      [ADFng1-02008] - Application level deployment profile names - For deployment profiles created at the application workspace level, the deployment profile name should be the same as the application workspace name.

      Trying to avoid using the same name for different things, is a general guidline that can help to avoid confusion.

      In case of naming guideline [ADFng1-02008], confusion about when a name refers to a deployment profile or an application workspace name can be avoided by adding a suffix "-dp" to the deployment profile name.
      Such confusion could occur when referring to a deployment profile while using ojdeploy, or when referring to a deployment profile in general.
      Also when multiple deployment profiles exist, a "-dp" suffix would allow to easily recognise a name as a deployment profile name.

      Given that different naming guidelines [1] suggest to "have the suffix", this also does not seem to conflict with naming guideline [ADFng1-01014], "Don't use Hungarian notation".

      many thanks
      Jan Vervecken

        Issue Links

          Activity

          Hide
          Torsten Kleiber added a comment -

          Enhacement request for renaming application and project deployment profiles has be create and is public accessible: 16218393.

          Do we have to create for tracking this an new jira issue here?

          Show
          Torsten Kleiber added a comment - Enhacement request for renaming application and project deployment profiles has be create and is public accessible: 16218393. Do we have to create for tracking this an new jira issue here?
          Hide
          Ulrich Gerkmann-Bartels added a comment -

          Hi,

          We think you need maybe more than one deployment profile inside a project / application workspace.

          So we look at different needs:

          a.) build / continuous integration / delivery

          We need a simple convention with following aspects:

          • automatic find of the deployment profile,
          • filter for different stages (test, integration, production, with signing pf jars etc.)
          • separate from deployment profiles need by the developer

          Our build scripts find automatic new project's and build for the different stages by using following convention:

          build*
          build_test*
          build_int*
          build_prod*

          Should be the project/modul integrated in the continuous integration process the developer simple use this convention. In simple project most the deployment profile is named: build. So it is easy to remember.

          The naming of the artifact don't following the deployment profile name. But this is a other convention.

          b.) development

          • The naming of this deployment profiles ist up to the developer but not a.)

          Ulrich Gerkmann-Bartels

          Show
          Ulrich Gerkmann-Bartels added a comment - Hi, We think you need maybe more than one deployment profile inside a project / application workspace. So we look at different needs: a.) build / continuous integration / delivery We need a simple convention with following aspects: automatic find of the deployment profile, filter for different stages (test, integration, production, with signing pf jars etc.) separate from deployment profiles need by the developer Our build scripts find automatic new project's and build for the different stages by using following convention: build* build_test* build_int* build_prod* Should be the project/modul integrated in the continuous integration process the developer simple use this convention. In simple project most the deployment profile is named: build. So it is easy to remember. The naming of the artifact don't following the deployment profile name. But this is a other convention. b.) development The naming of this deployment profiles ist up to the developer but not a.) Ulrich Gerkmann-Bartels
          Hide
          chriscmuir added a comment -

          @tkleiber - thanks for logging the ER. Please lodge a separate issue on the ADF EMG issue tracker so we can track that ER separately to this piece of work that relates to the guidelines. In the new issue just refer back to this issue.

          @tkleiber & @Ulrich - returning to the naming conventions - putting aside including the workspace/project name embedded in the deployment profile name for the moment, what it appears both tkleiber and Ulrich have identified is that both rules 02008 and 02009 require a change to accommodate the "need" or "use" of the deployment profile. Both of you have identified different needs, tkleiber through flagging SSO/non SSO use, Ulrich the 3 aspects you discussed.

          I don't think it's possible to articulate all the different types of needs for the purposes of defining the rules, because in reality that could be a multiplication of every known option under every known deployment profile type and what every arbitrary uses you have at each site. As such to still present a simple version of the rules, we just state something like:

          [ADFng2-02008] – Application level deployment profile names – For deployment profiles created at the application workspace level, the deployment profile name should be the same as the application workspace name. If you have more than one deployment profile that correspondences to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><Need>.

          For example: Procurement or ProcurementTest or ProcurementProd

          [ADFng2-02009] – Project level deployment profile names – For deployment profiles created at the project level, the deployment profile name should take the form <WorkspaceName><ProjectName>, for example CommonModel or HrViewController. If you have more than one deployment profile that correspondences to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><ProjectName><Need>.

          For Example: CommonModel or CommonModelTest or CommonModelProd

          ...as a result of the change of these rules this will also require a change to rule ADFng1-02010 because at the moment that rule would have the need/use part of the deployment profile reflected in the artefact name. This is undesirable as the IDE hardcodes dependencies based on their path and filename, rather than using a CLASSPATH, that makes slipping in different versions of dependent libraries difficult if the file name changes.

          At this time rule ADFng1-02010 is stil under discussion at http://java.net/jira/browse/ADFEMG-102 but a preliminary rewrite of that rule is as follows:

          [ADFng2-02010] - Deployment profile archive name and file extensions - the archive name and file extension that is produced for the relating deployment profile should be the same as the deployment profile name minus the need/use as defined in rules 02009 and 02010, all in lowercase as per the Java convention , with a use of an appropriate file type. For example:
          • ADF Library <deploymentprofilename>.jar commonmodel.jar
          • EAR File <deploymentprofilename>.ear procurement.ear
          • JAR File <deploymentprofilename>.jar utilities.jar
          • WAR File <deploymentprofilename>.war hr.war

          Show
          chriscmuir added a comment - @tkleiber - thanks for logging the ER. Please lodge a separate issue on the ADF EMG issue tracker so we can track that ER separately to this piece of work that relates to the guidelines. In the new issue just refer back to this issue. @tkleiber & @Ulrich - returning to the naming conventions - putting aside including the workspace/project name embedded in the deployment profile name for the moment, what it appears both tkleiber and Ulrich have identified is that both rules 02008 and 02009 require a change to accommodate the "need" or "use" of the deployment profile. Both of you have identified different needs, tkleiber through flagging SSO/non SSO use, Ulrich the 3 aspects you discussed. I don't think it's possible to articulate all the different types of needs for the purposes of defining the rules, because in reality that could be a multiplication of every known option under every known deployment profile type and what every arbitrary uses you have at each site. As such to still present a simple version of the rules, we just state something like: • [ADFng2-02008] – Application level deployment profile names – For deployment profiles created at the application workspace level, the deployment profile name should be the same as the application workspace name. If you have more than one deployment profile that correspondences to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><Need>. For example: Procurement or ProcurementTest or ProcurementProd • [ADFng2-02009] – Project level deployment profile names – For deployment profiles created at the project level, the deployment profile name should take the form <WorkspaceName><ProjectName>, for example CommonModel or HrViewController. If you have more than one deployment profile that correspondences to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><ProjectName><Need>. For Example: CommonModel or CommonModelTest or CommonModelProd ...as a result of the change of these rules this will also require a change to rule ADFng1-02010 because at the moment that rule would have the need/use part of the deployment profile reflected in the artefact name. This is undesirable as the IDE hardcodes dependencies based on their path and filename, rather than using a CLASSPATH, that makes slipping in different versions of dependent libraries difficult if the file name changes. At this time rule ADFng1-02010 is stil under discussion at http://java.net/jira/browse/ADFEMG-102 but a preliminary rewrite of that rule is as follows: • [ADFng2-02010] - Deployment profile archive name and file extensions - the archive name and file extension that is produced for the relating deployment profile should be the same as the deployment profile name minus the need/use as defined in rules 02009 and 02010, all in lowercase as per the Java convention , with a use of an appropriate file type. For example: • ADF Library <deploymentprofilename>.jar commonmodel.jar • EAR File <deploymentprofilename>.ear procurement.ear • JAR File <deploymentprofilename>.jar utilities.jar • WAR File <deploymentprofilename>.war hr.war
          Hide
          chriscmuir added a comment -

          Changes have been made to v2.0 of this doc. Closing the issue.

          Show
          chriscmuir added a comment - Changes have been made to v2.0 of this doc. Closing the issue.
          Hide
          Jan Vervecken added a comment -

          Thank you for the update Chris.

          • about "@tkleiber - thanks for logging the ER. Please lodge a separate issue on the ADF EMG issue tracker ..."
            • see JIRA issue ADFEMG-103 "Allow renaming application and project deployment profiles"
          • about "Changes have been made to v2.0 of this doc."
            • As can be found in "ADF Naming and Project Layout Guidelines v2.00" [1] :

              [ADFng2-02008] – Application level deployment profile names – For deployment profiles created at the application workspace level, the deployment profile name should be the same as the application workspace name. If you have more than one deployment profile that correspondence to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><Need>.

          regards
          Jan Vervecken

          Show
          Jan Vervecken added a comment - Thank you for the update Chris. about "@tkleiber - thanks for logging the ER. Please lodge a separate issue on the ADF EMG issue tracker ..." see JIRA issue ADFEMG-103 "Allow renaming application and project deployment profiles" about "Changes have been made to v2.0 of this doc." As can be found in "ADF Naming and Project Layout Guidelines v2.00" [1] : [ADFng2-02008] – Application level deployment profile names – For deployment profiles created at the application workspace level, the deployment profile name should be the same as the application workspace name. If you have more than one deployment profile that correspondence to different needs/use, include the need/use as a suffix such that it takes the form <WorkspaceName><Need>. [1] http://www.oracle.com/technetwork/developer-tools/adf/learnmore/adf-naming-layout-guidelines-v2-00-1904828.pdf regards Jan Vervecken

            People

            • Assignee:
              Unassigned
              Reporter:
              Jan Vervecken
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: