Hi All, We have developed two test cases to check whether samples directory (if exists) has a README.txt/pom.xml/build.xml at the same level where src directory exists and to check whether resources directory (inside the src) contains any files.
Regards On Fri, Nov 8, 2013 at 3:21 PM, Dimuthu De Lanerolle <[email protected]>wrote: > Product teams - can we get some inputs on this ? > > > On Fri, Nov 8, 2013 at 9:22 AM, Krishantha Samaraweera < > [email protected]> wrote: > >> IMO, we can proceed with maven directory structure for samples with >> source file. Those samples should have README and pom.xml or build.xml in >> the root. For the time being, we can write tests to report structure >> violations only, so those tests will not get fail initially. After >> analyzing the report we can create product JIRAs to track sample directory >> structure violations. Then the test case can be enabled only for the >> products with proper sample structure. >> >> For Jaggery and DSS samples, we can ask product teams to follow structure >> like below. >> >> sample-name >> ├── README.txt >> └── resources >> ├── sampleDSSService.dbs >> └── test.jag >> >> Product teams, please come up with your suggestions. otherwise we will >> follow the above proposed structure and proceed with validating product >> distribution. >> >> Thanks, >> Krishantha. >> >> >> On Thu, Nov 7, 2013 at 8:39 PM, Dimuthu De Lanerolle >> <[email protected]>wrote: >> >>> I have gone through Apache-camel, Apache-cxf , axis2 projects to >>> identify a common structure. In camel projects there were many samples and >>> each one is structured using a more common pattern. eg: if you dig into the >>> contents in each sample directory it consists of a src directory, pom.xml & >>> a README.txt file at the root level. Inside the src directory there are >>> main and test directories. resources are located in each of these >>> directories. (refer the tree figure below - for main directory) .Directory >>> structure in cxf projects are also the same. (there may be slight changes >>> like setting common set of samples into a one directory etc.). Axis2 on the >>> other hand reflects the same structure except for resources which are >>> included at the same level were src directory is located with. >>> >>> ├── camel-example-tracer >>> │ ├── pom.xml >>> │ ├── README.txt >>> │ └── src >>> │ └── main >>> │ ├── java >>> │ │ └── org >>> │ │ └── apache >>> │ │ └── camel >>> │ │ └── example >>> │ │ └── tracer >>> │ │ ├── FixedDerbyDialect.java >>> │ │ ├── Main.java >>> │ │ ├── QuoteAggregator.java >>> │ │ └── QuoteService.java >>> │ └── resources >>> │ ├── features.xml >>> │ ├── log4j.properties >>> │ └── META-INF >>> │ ├── LICENSE.txt >>> │ ├── NOTICE.txt >>> │ ├── persistence.xml >>> │ └── spring >>> │ └── camel-context.xml >>> >>> >>> I have discussed the issue of DSS samples with Chanika and the >>> possibility of organizing DSS samples in-accordance with a common standard >>> will most probably be successful. However, we may not worry about mashup >>> samples as they will be discontinued in the future releases as confirmed by >>> NuwanB. But for samples like Jaggery we might need to develop a new >>> strategy unless we put those to a directory and call it src / resources . >>> My suggestion in this regard is that we better adhere into samples >>> directory structure shown in Apache camel/ cxf projects which seems to be >>> quite a good reasonable one. (we may need to consider the opportunity >>> cost of this) . If not we need to propose another generic standard for >>> implementing sample directories structure to our products. >>> >>> Regards >>> >>> >>> >>> On Thu, Nov 7, 2013 at 3:38 PM, Dimuthu De Lanerolle >>> <[email protected]>wrote: >>> >>>> Hi Krishantha, >>>> >>>> Yes I have gone through Esb & Greg samples. Samples like Jaggery >>>> (inside AS) , DSS samples are in different formats. DSS samples are >>>> organized in a manner, placing all sample code classes in a single src >>>> directory and keeping resources in separate directories. In Jaggery samples >>>> each sample is categorized into separate applications. There are some other >>>> samples such as mashupSamples which are also organized in different >>>> directory structures. >>>> >>>> Regards >>>> >>>> >>>> On Thu, Nov 7, 2013 at 1:20 PM, Krishantha Samaraweera < >>>> [email protected]> wrote: >>>> >>>>> Hi Dimuthu, >>>>> >>>>> Can you come up with a few suggestions too, since you have gone though >>>>> other Apache projects, you can suggest best suited sample structures for >>>>> us. Did you check the G-Reg and ESB samples, AFAIK those sample are more >>>>> organized. If we cannot find with uniform structure then maintaining >>>>> product specific structure will be the solution. >>>>> >>>>> What are the products samples which we cannot enforce uniform sample >>>>> structure ? please mention the sample/artifact types etc.. >>>>> >>>>> Thanks, >>>>> Krishantha. >>>>> >>>>> >>>>> On Thu, Nov 7, 2013 at 12:31 PM, Dimuthu De Lanerolle < >>>>> [email protected]> wrote: >>>>> >>>>>> I have referred several apache projects to identify a common pattern >>>>>> for samples directory structure. However, it seems like there is no >>>>>> specific structure being imposed on such scenario. AFAIU most of the >>>>>> projects you can find around are following the maven standard directory >>>>>> structure. Can we agree upon a common standard for samples directory >>>>>> structure? We need to address a few questions like where to keep >>>>>> resources >>>>>> of each sample directory - whether to keep those inside respective sample >>>>>> directories or create a public resources directory to which all samples >>>>>> are >>>>>> granted access with. There might be different types of pros and cons in >>>>>> each procedure like duplication of resource files etc. Therefore what >>>>>> will >>>>>> be the best way to implement the sample directory structure? Pls give us >>>>>> your suggestions to derive a suitable uniformity. >>>>>> >>>>>> Regards >>>>>> >>>>>> >>>>>> On Tue, Nov 5, 2013 at 3:34 PM, Prabath Abeysekera <[email protected] >>>>>> > wrote: >>>>>> >>>>>>> [Looping Chanika (from DSS team) in.] >>>>>>> >>>>>>> Dimuthu, please talk to DSS folks and get this resolved. >>>>>>> >>>>>>> >>>>>>> Cheers, >>>>>>> Prabath >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> On Tue, Nov 5, 2013 at 3:19 PM, Dimuthu De Lanerolle < >>>>>>> [email protected]> wrote: >>>>>>> >>>>>>>> including PrabathA of DSS team as I had an offline chat with him in >>>>>>>> this regard. >>>>>>>> >>>>>>>> >>>>>>>> On Tue, Nov 5, 2013 at 3:00 PM, Dimuthu De Lanerolle < >>>>>>>> [email protected]> wrote: >>>>>>>> >>>>>>>>> Hi Krishantha, >>>>>>>>> >>>>>>>>> We noted that samples directory structure differs from product to >>>>>>>>> product. For an example, AS released 5.2.0 has many samples inside >>>>>>>>> the >>>>>>>>> wso2as-5.2.0/samples directory together with resources being placed >>>>>>>>> inside >>>>>>>>> each sample while wso2dss-3.1.0/samples contains resources for >>>>>>>>> samples in >>>>>>>>> common directories. In addition, these samples do not contain src >>>>>>>>> directories. Therefore we will implement the test based on the samples >>>>>>>>> directory structure inside the appserver. In my view , I think it is >>>>>>>>> better >>>>>>>>> if we can propose a more common structure for xxx/samples directory >>>>>>>>> so that >>>>>>>>> all products will carry the uniformity. >>>>>>>>> >>>>>>>>> Regards >>>>>>>>> >>>>>>>>> >>>>>>>>> On Tue, Nov 5, 2013 at 11:58 AM, Dimuthu De Lanerolle < >>>>>>>>> [email protected]> wrote: >>>>>>>>> >>>>>>>>>> Hi, >>>>>>>>>> >>>>>>>>>> We will implement tests for following scenarios. >>>>>>>>>> >>>>>>>>>> 1. To check whether each sample's src directory contains any files >>>>>>>>>> 2. Sample directories (top most level) have embedded versions in >>>>>>>>>> their names. >>>>>>>>>> >>>>>>>>>> Regards >>>>>>>>>> >>>>>>>>>> -- >>>>>>>>>> Dimuthu De Lanerolle >>>>>>>>>> Software Engineer >>>>>>>>>> WSO2 Inc. >>>>>>>>>> lean . enterprise . middlewear. >>>>>>>>>> http://wso2.com/ >>>>>>>>>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : >>>>>>>>>> [email protected] >>>>>>>>>> >>>>>>>>>> >>>>>>>>> >>>>>>>>> >>>>>>>>> -- >>>>>>>>> Dimuthu De Lanerolle >>>>>>>>> Software Engineer >>>>>>>>> WSO2 Inc. >>>>>>>>> lean . enterprise . middlewear. >>>>>>>>> http://wso2.com/ >>>>>>>>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : >>>>>>>>> [email protected] >>>>>>>>> >>>>>>>>> >>>>>>>> >>>>>>>> >>>>>>>> -- >>>>>>>> Dimuthu De Lanerolle >>>>>>>> Software Engineer >>>>>>>> WSO2 Inc. >>>>>>>> lean . enterprise . middlewear. >>>>>>>> http://wso2.com/ >>>>>>>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : >>>>>>>> [email protected] >>>>>>>> >>>>>>>> >>>>>>> >>>>>>> >>>>>>> -- >>>>>>> Prabath Abeysekara >>>>>>> Associate Technical Lead, Data TG. >>>>>>> WSO2 Inc. >>>>>>> Email: [email protected] >>>>>>> Mobile: +94774171471 >>>>>>> >>>>>> >>>>>> >>>>>> >>>>>> -- >>>>>> Dimuthu De Lanerolle >>>>>> Software Engineer >>>>>> WSO2 Inc. >>>>>> lean . enterprise . middlewear. >>>>>> http://wso2.com/ >>>>>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : >>>>>> [email protected] >>>>>> >>>>>> >>>>> >>>>> >>>>> -- >>>>> Krishantha Samaraweera >>>>> Senior Technical Lead - Test Automation >>>>> Mobile: +94 77 7759918 >>>>> WSO2, Inc.; http://wso2.com/ >>>>> lean . enterprise . middlewear. >>>>> >>>> >>>> >>>> >>>> -- >>>> Dimuthu De Lanerolle >>>> Software Engineer >>>> WSO2 Inc. >>>> lean . enterprise . middlewear. >>>> http://wso2.com/ >>>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : [email protected] >>>> >>>> >>> >>> >>> -- >>> Dimuthu De Lanerolle >>> Software Engineer >>> WSO2 Inc. >>> lean . enterprise . middlewear. >>> http://wso2.com/ >>> Tel. : +94 11 2145345 Fax : +94 11 2145300 email : [email protected] >>> >>> >> >> >> -- >> Krishantha Samaraweera >> Senior Technical Lead - Test Automation >> Mobile: +94 77 7759918 >> WSO2, Inc.; http://wso2.com/ >> lean . enterprise . middlewear. >> > > > > -- > Dimuthu De Lanerolle > Software Engineer > WSO2 Inc. > lean . enterprise . middlewear. > http://wso2.com/ > Tel. : +94 11 2145345 Fax : +94 11 2145300 email : [email protected] > > -- Dimuthu De Lanerolle Software Engineer WSO2 Inc. lean . enterprise . middlewear. http://wso2.com/ Tel. : +94 11 2145345 Fax : +94 11 2145300 email : [email protected]
_______________________________________________ Dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/dev
