[edk2-devel] [Patch] GenBiosId: Enable GenBiosId to set timestamp as zero

Bob Feng posted 1 patch 1 week ago
Failed in applying to current master (apply log)
Platform/Intel/Tools/GenBiosId/GenBiosId.py | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)

[edk2-devel] [Patch] GenBiosId: Enable GenBiosId to set timestamp as zero

Posted by Bob Feng 1 week ago
BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=2384

We need eliminate the effect of timestamp to verify
the reproducible build.

This patch is to add the support for GenBiosId to set
timestamp as zero.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Steven Shi <steven.shi@intel.com>
Signed-off-by: Bob Feng <bob.c.feng@intel.com>
---
 Platform/Intel/Tools/GenBiosId/GenBiosId.py | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/Platform/Intel/Tools/GenBiosId/GenBiosId.py b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
index 31abb24d31..1b25621104 100644
--- a/Platform/Intel/Tools/GenBiosId/GenBiosId.py
+++ b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
@@ -100,26 +100,28 @@ def MyOptionParser():
     parser.add_argument('-v', '--version', action='version', version=__version__,
                         help="show program's version number and exit")
     parser.add_argument('-i', '--int', metavar='FILENAME', dest='InputFile', help="Input Config file")
     parser.add_argument('-o', '--out', metavar='FILENAME', dest='OutputFile', help="Output file")
     parser.add_argument('-ot', '--text', metavar='FILENAME', dest='OutputTextFile', help="Output Text file")
+    parser.add_argument('-NT', '--NoTimeStamp', dest='NoTimestamp', action='store_true', default=False, help="Set timestamp to zero")
     Options = parser.parse_args()
     return Options
 
 
 # Check the Tool for missing variables
 def CheckOptions(Options):
-    if len(sys.argv) != 5 and not (len(sys.argv) == 7 and Options.OutputTextFile):
+    if len(sys.argv) not in [5,6] and not (len(sys.argv) not in [7,8] and Options.OutputTextFile):
         EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
     elif not Options.InputFile or not Options.OutputFile:
         EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
     InputFile = Options.InputFile
     OutputFile = Options.OutputFile
     OutputTextFile = Options.OutputTextFile
+    NoTimestamp = Options.NoTimestamp
     if not os.path.exists(InputFile):
         EdkLogger("GenBiosId", FILE_NOT_FOUND, ExtraData="Input file not found")
-    return InputFile, OutputFile, OutputTextFile
+    return InputFile, OutputFile, OutputTextFile,NoTimestamp
 
 # Read input file and get config
 def ReadInputFile(InputFile):
     InputDict = OrderedDict()
     with open(InputFile) as File:
@@ -132,23 +134,25 @@ def ReadInputFile(InputFile):
             InputDict[Key.strip()] = Value.strip()
     return InputDict
 
 
 # Parse the input file and extract the information
-def ParserInputFile(InputDict):
+def ParserInputFile(InputDict,NoTimestamp):
     for Item in InputDict:
         if Item not in _ConfigItem:
             EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigItemInvalid % Item)
         _ConfigItem[Item]['Value'] = InputDict[Item]
         if len(_ConfigItem[Item]['Value']) != _ConfigItem[Item]['Length']:
             EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigLenInvalid % Item)
     for Item in _ConfigItem:
         if not _ConfigItem[Item]['Value']:
             EdkLogger("GenBiosId", FORMAT_UNKNOWN_ERROR, ExtraData="Item %s is missing" % Item)
     utcnow = datetime.datetime.utcnow()
-    TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
-
+    if NoTimestamp:
+        TimeStamp = "\0\0\0\0\0\0\0\0\0\0"
+    else:
+        TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
     Id_Str = _ConfigItem['BOARD_ID']['Value'] + _ConfigItem['BOARD_REV']['Value'] + '.' + _ConfigItem['BOARD_EXT'][
         'Value'] + '.' + _ConfigItem['VERSION_MAJOR']['Value'] + \
              '.' + _ConfigItem["BUILD_TYPE"]['Value'] + _ConfigItem['VERSION_MINOR']['Value'] + '.' + TimeStamp
     return Id_Str
 
@@ -169,13 +173,13 @@ def PrintOutputFile(OutputFile, OutputTextFile, Id_Str):
 
 
 # Tool entrance method
 def Main():
     Options = MyOptionParser()
-    InputFile, OutputFile, OutputTextFile = CheckOptions(Options)
+    InputFile, OutputFile, OutputTextFile,NoTimestamp = CheckOptions(Options)
     InputDict = ReadInputFile(InputFile)
-    Id_Str = ParserInputFile(InputDict)
+    Id_Str = ParserInputFile(InputDict,NoTimestamp)
     PrintOutputFile(OutputFile, OutputTextFile, Id_Str)
     return 0
 
 
 if __name__ == '__main__':
-- 
2.20.1.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#51215): https://edk2.groups.io/g/devel/message/51215
Mute This Topic: https://groups.io/mt/61908239/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [Patch] GenBiosId: Enable GenBiosId to set timestamp as zero

Posted by Philippe Mathieu-Daudé 1 week ago
Hi Bob,

On 11/25/19 9:05 AM, Bob Feng via Groups.Io wrote:
> BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=2384
> 
> We need eliminate the effect of timestamp to verify
> the reproducible build.
> 
> This patch is to add the support for GenBiosId to set
> timestamp as zero.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Steven Shi <steven.shi@intel.com>
> Signed-off-by: Bob Feng <bob.c.feng@intel.com>
> ---
>   Platform/Intel/Tools/GenBiosId/GenBiosId.py | 18 +++++++++++-------
>   1 file changed, 11 insertions(+), 7 deletions(-)
> 
> diff --git a/Platform/Intel/Tools/GenBiosId/GenBiosId.py b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> index 31abb24d31..1b25621104 100644
> --- a/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> +++ b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> @@ -100,26 +100,28 @@ def MyOptionParser():
>       parser.add_argument('-v', '--version', action='version', version=__version__,
>                           help="show program's version number and exit")
>       parser.add_argument('-i', '--int', metavar='FILENAME', dest='InputFile', help="Input Config file")
>       parser.add_argument('-o', '--out', metavar='FILENAME', dest='OutputFile', help="Output file")
>       parser.add_argument('-ot', '--text', metavar='FILENAME', dest='OutputTextFile', help="Output Text file")
> +    parser.add_argument('-NT', '--NoTimeStamp', dest='NoTimestamp', action='store_true', default=False, help="Set timestamp to zero")

All other options are in lowercase, why use CamelCase here? Can we use 
'-nt', '--notimestamp' to keep the style?

Two minor style comment below; except the style comments the patch looks 
good.

>       Options = parser.parse_args()
>       return Options
>   
>   
>   # Check the Tool for missing variables
>   def CheckOptions(Options):
> -    if len(sys.argv) != 5 and not (len(sys.argv) == 7 and Options.OutputTextFile):
> +    if len(sys.argv) not in [5,6] and not (len(sys.argv) not in [7,8] and Options.OutputTextFile):
>           EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
>       elif not Options.InputFile or not Options.OutputFile:
>           EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
>       InputFile = Options.InputFile
>       OutputFile = Options.OutputFile
>       OutputTextFile = Options.OutputTextFile
> +    NoTimestamp = Options.NoTimestamp
>       if not os.path.exists(InputFile):
>           EdkLogger("GenBiosId", FILE_NOT_FOUND, ExtraData="Input file not found")
> -    return InputFile, OutputFile, OutputTextFile
> +    return InputFile, OutputFile, OutputTextFile,NoTimestamp

Missing space before NoTimestamp.

>   
>   # Read input file and get config
>   def ReadInputFile(InputFile):
>       InputDict = OrderedDict()
>       with open(InputFile) as File:
> @@ -132,23 +134,25 @@ def ReadInputFile(InputFile):
>               InputDict[Key.strip()] = Value.strip()
>       return InputDict
>   
>   
>   # Parse the input file and extract the information
> -def ParserInputFile(InputDict):
> +def ParserInputFile(InputDict,NoTimestamp):
>       for Item in InputDict:
>           if Item not in _ConfigItem:
>               EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigItemInvalid % Item)
>           _ConfigItem[Item]['Value'] = InputDict[Item]
>           if len(_ConfigItem[Item]['Value']) != _ConfigItem[Item]['Length']:
>               EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigLenInvalid % Item)
>       for Item in _ConfigItem:
>           if not _ConfigItem[Item]['Value']:
>               EdkLogger("GenBiosId", FORMAT_UNKNOWN_ERROR, ExtraData="Item %s is missing" % Item)
>       utcnow = datetime.datetime.utcnow()
> -    TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
> -
> +    if NoTimestamp:
> +        TimeStamp = "\0\0\0\0\0\0\0\0\0\0"
> +    else:
> +        TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
>       Id_Str = _ConfigItem['BOARD_ID']['Value'] + _ConfigItem['BOARD_REV']['Value'] + '.' + _ConfigItem['BOARD_EXT'][
>           'Value'] + '.' + _ConfigItem['VERSION_MAJOR']['Value'] + \
>                '.' + _ConfigItem["BUILD_TYPE"]['Value'] + _ConfigItem['VERSION_MINOR']['Value'] + '.' + TimeStamp
>       return Id_Str
>   
> @@ -169,13 +173,13 @@ def PrintOutputFile(OutputFile, OutputTextFile, Id_Str):
>   
>   
>   # Tool entrance method
>   def Main():
>       Options = MyOptionParser()
> -    InputFile, OutputFile, OutputTextFile = CheckOptions(Options)
> +    InputFile, OutputFile, OutputTextFile,NoTimestamp = CheckOptions(Options)

Missing space before NoTimestamp.

>       InputDict = ReadInputFile(InputFile)
> -    Id_Str = ParserInputFile(InputDict)
> +    Id_Str = ParserInputFile(InputDict,NoTimestamp)
>       PrintOutputFile(OutputFile, OutputTextFile, Id_Str)
>       return 0
>   
>   
>   if __name__ == '__main__':
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#51229): https://edk2.groups.io/g/devel/message/51229
Mute This Topic: https://groups.io/mt/61908239/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [Patch] GenBiosId: Enable GenBiosId to set timestamp as zero

Posted by Bob Feng 1 week ago
I agree.  Thanks for your comments. I'll update it in patch v2.

-----Original Message-----
From: Philippe Mathieu-Daudé [mailto:philmd@redhat.com] 
Sent: Monday, November 25, 2019 6:56 PM
To: devel@edk2.groups.io; Feng, Bob C <bob.c.feng@intel.com>
Cc: Gao, Liming <liming.gao@intel.com>; Shi, Steven <steven.shi@intel.com>
Subject: Re: [edk2-devel] [Patch] GenBiosId: Enable GenBiosId to set timestamp as zero

Hi Bob,

On 11/25/19 9:05 AM, Bob Feng via Groups.Io wrote:
> BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=2384
> 
> We need eliminate the effect of timestamp to verify the reproducible 
> build.
> 
> This patch is to add the support for GenBiosId to set timestamp as 
> zero.
> 
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Steven Shi <steven.shi@intel.com>
> Signed-off-by: Bob Feng <bob.c.feng@intel.com>
> ---
>   Platform/Intel/Tools/GenBiosId/GenBiosId.py | 18 +++++++++++-------
>   1 file changed, 11 insertions(+), 7 deletions(-)
> 
> diff --git a/Platform/Intel/Tools/GenBiosId/GenBiosId.py 
> b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> index 31abb24d31..1b25621104 100644
> --- a/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> +++ b/Platform/Intel/Tools/GenBiosId/GenBiosId.py
> @@ -100,26 +100,28 @@ def MyOptionParser():
>       parser.add_argument('-v', '--version', action='version', version=__version__,
>                           help="show program's version number and exit")
>       parser.add_argument('-i', '--int', metavar='FILENAME', dest='InputFile', help="Input Config file")
>       parser.add_argument('-o', '--out', metavar='FILENAME', dest='OutputFile', help="Output file")
>       parser.add_argument('-ot', '--text', metavar='FILENAME', 
> dest='OutputTextFile', help="Output Text file")
> +    parser.add_argument('-NT', '--NoTimeStamp', dest='NoTimestamp', 
> + action='store_true', default=False, help="Set timestamp to zero")

All other options are in lowercase, why use CamelCase here? Can we use '-nt', '--notimestamp' to keep the style?

Two minor style comment below; except the style comments the patch looks good.

>       Options = parser.parse_args()
>       return Options
>   
>   
>   # Check the Tool for missing variables
>   def CheckOptions(Options):
> -    if len(sys.argv) != 5 and not (len(sys.argv) == 7 and Options.OutputTextFile):
> +    if len(sys.argv) not in [5,6] and not (len(sys.argv) not in [7,8] and Options.OutputTextFile):
>           EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
>       elif not Options.InputFile or not Options.OutputFile:
>           EdkLogger("GenBiosId", OPTION_MISSING, ExtraData=_Usage)
>       InputFile = Options.InputFile
>       OutputFile = Options.OutputFile
>       OutputTextFile = Options.OutputTextFile
> +    NoTimestamp = Options.NoTimestamp
>       if not os.path.exists(InputFile):
>           EdkLogger("GenBiosId", FILE_NOT_FOUND, ExtraData="Input file not found")
> -    return InputFile, OutputFile, OutputTextFile
> +    return InputFile, OutputFile, OutputTextFile,NoTimestamp

Missing space before NoTimestamp.

>   
>   # Read input file and get config
>   def ReadInputFile(InputFile):
>       InputDict = OrderedDict()
>       with open(InputFile) as File:
> @@ -132,23 +134,25 @@ def ReadInputFile(InputFile):
>               InputDict[Key.strip()] = Value.strip()
>       return InputDict
>   
>   
>   # Parse the input file and extract the information -def 
> ParserInputFile(InputDict):
> +def ParserInputFile(InputDict,NoTimestamp):
>       for Item in InputDict:
>           if Item not in _ConfigItem:
>               EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigItemInvalid % Item)
>           _ConfigItem[Item]['Value'] = InputDict[Item]
>           if len(_ConfigItem[Item]['Value']) != _ConfigItem[Item]['Length']:
>               EdkLogger("GenBiosId", FORMAT_INVALID, ExtraData=_ConfigLenInvalid % Item)
>       for Item in _ConfigItem:
>           if not _ConfigItem[Item]['Value']:
>               EdkLogger("GenBiosId", FORMAT_UNKNOWN_ERROR, ExtraData="Item %s is missing" % Item)
>       utcnow = datetime.datetime.utcnow()
> -    TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
> -
> +    if NoTimestamp:
> +        TimeStamp = "\0\0\0\0\0\0\0\0\0\0"
> +    else:
> +        TimeStamp = time.strftime("%y%m%d%H%M", utcnow.timetuple())
>       Id_Str = _ConfigItem['BOARD_ID']['Value'] + _ConfigItem['BOARD_REV']['Value'] + '.' + _ConfigItem['BOARD_EXT'][
>           'Value'] + '.' + _ConfigItem['VERSION_MAJOR']['Value'] + \
>                '.' + _ConfigItem["BUILD_TYPE"]['Value'] + _ConfigItem['VERSION_MINOR']['Value'] + '.' + TimeStamp
>       return Id_Str
>   
> @@ -169,13 +173,13 @@ def PrintOutputFile(OutputFile, OutputTextFile, Id_Str):
>   
>   
>   # Tool entrance method
>   def Main():
>       Options = MyOptionParser()
> -    InputFile, OutputFile, OutputTextFile = CheckOptions(Options)
> +    InputFile, OutputFile, OutputTextFile,NoTimestamp = 
> + CheckOptions(Options)

Missing space before NoTimestamp.

>       InputDict = ReadInputFile(InputFile)
> -    Id_Str = ParserInputFile(InputDict)
> +    Id_Str = ParserInputFile(InputDict,NoTimestamp)
>       PrintOutputFile(OutputFile, OutputTextFile, Id_Str)
>       return 0
>   
>   
>   if __name__ == '__main__':
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#51263): https://edk2.groups.io/g/devel/message/51263
Mute This Topic: https://groups.io/mt/61908239/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-