[Freeipa-devel] [PATCH 70] validate i18n strings when running "make lint"

[John Dennis]

On 04/12/2012 09:26 AM, Petr Viktorin wrote:
> On 03/30/2012 03:45 AM, John Dennis wrote:
>> Translatable strings have certain requirements for proper translation
>> and run time behaviour. We should routinely validate those strings. A
>> recent checkin to install/po/test_i18n.py makes it possible to validate
>> the contents of our current pot file by searching for problematic strings.
>>
>> However, we only occasionally generate a new pot file, far less
>> frequently than translatable strings change in the source base. Just
>> like other checkin's to the source which are tested for correctness we
>> should also validate new or modified translation strings when they are
>> introduced and not accumulate problems to fix at the last minute. This
>> would also raise the awareness of developers as to the requirements for
>> proper string translation.
>>
>> The top level Makefile should be enhanced to create a temporary pot
>> files from the current sources and validate it. We need to use a
>> temporary pot file because we do not want to modify the pot file under
>> source code control and exported to Transifex.
>>
>
> NACK
>
> install/po/Makefile is not created early enough when running `make rpms`
> from a clean checkout.
>
> # git clean -fx
> ...
> # make rpms
> rm -rf /rpmbuild
> mkdir -p /rpmbuild/BUILD
> mkdir -p /rpmbuild/RPMS
> mkdir -p /rpmbuild/SOURCES
> mkdir -p /rpmbuild/SPECS
> mkdir -p /rpmbuild/SRPMS
> mkdir -p dist/rpms
> mkdir -p dist/srpms
> if [ ! -e RELEASE ]; then echo 0>  RELEASE; fi
> sed -e s/__VERSION__/2.99.0GITde16a82/ -e s/__RELEASE__/0/ \
>           freeipa.spec.in>  freeipa.spec
> sed -e s/__VERSION__/2.99.0GITde16a82/ version.m4.in \
>           >  version.m4
> sed -e s/__VERSION__/2.99.0GITde16a82/ ipapython/setup.py.in \
>           >  ipapython/setup.py
> sed -e s/__VERSION__/2.99.0GITde16a82/ ipapython/version.py.in \
>           >  ipapython/version.py
> perl -pi -e "s:__NUM_VERSION__:2990:" ipapython/version.py
> perl -pi -e "s:__API_VERSION__:2.34:" ipapython/version.py
> sed -e s/__VERSION__/2.99.0GITde16a82/ daemons/ipa-version.h.in \
>           >  daemons/ipa-version.h
> perl -pi -e "s:__NUM_VERSION__:2990:" daemons/ipa-version.h
> perl -pi -e "s:__DATA_VERSION__:20100614120000:" daemons/ipa-version.h
> sed -e s/__VERSION__/2.99.0GITde16a82/ -e s/__RELEASE__/0/ \
>           ipa-client/ipa-client.spec.in>  ipa-client/ipa-client.spec
> sed -e s/__VERSION__/2.99.0GITde16a82/ ipa-client/version.m4.in \
>           >  ipa-client/version.m4
> if [ "redhat" != "" ]; then \
>           sed -e s/SUPPORTED_PLATFORM/redhat/ ipapython/services.py.in \
>                   >  ipapython/services.py; \
> fi
> if [ "" != "yes" ]; then \
>           ./makeapi --validate; \
> fi
> make -C install/po validate-src-strings
> make[1]: Entering directory `/home/pviktori/freeipa/install/po'
> make[1]: *** No rule to make target `validate-src-strings'.  Stop.
> make[1]: Leaving directory `/home/pviktori/freeipa/install/po'
> make: *** [validate-src-strings] Error 2

Updated patch attached.

The fundamental problem is that we were trying to run code before 
configure had ever been run. We have dependencies on the output and side 
effects of configure. Therefore the solution is to add the 
bootstrap-autogen target as a dependency.

FWIW, I tried an approach that did not require having bootstrap-autogen 
run first by having the validation occur as part of the normal "make 
all". But that had some undesirable properties, first we really only 
want to run validation for developers, not during a normal build, 
secondly the file generation requires a git repo (see below).

But there is another reason to require running bootstrap-autogen prior 
to any validation (e.g. makeapi, make-lint, etc.) Those validation 
utilities need access to generated source files and those generated 
source files are supposed to be generated by the configure step. Right 
now we're generating them as part of updating version information. I 
will post a long email describing the problem on the devel list. So 
we've created a situation we we must run configure early on, even as 
part of "making the distribution" because part of "making the 
distribution" is validating the distribution and that requires the full 
content of the distribution be available.

Also while trying to determine if the i18n validation step executed 
correctly I realized the i18n validation only emitted a message if an 
error was detected. That made it impossible to distinguish between empty 
input (a problem when not running in a development tree) and successful 
validation. Therefore I also updated i18n.py to output counts of 
messages checked which also caused me to fix some validations that were 
missing on plural forms.


-- 
John Dennis <jdennis at redhat.com>

Looking to carve out IT costs?
www.redhat.com/carveoutcosts/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-jdennis-0070-1-validate-i18n-strings-when-running-make-lint.patch
Type: text/x-patch
Size: 10116 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20120416/9e94c200/attachment.bin>